logo
API docs by Redocly

Flux OS API (6.6.1)

Download OpenAPI specification:

E-mail: info@runonflux.com URL: https://docs.runonflux.io License: GNU AGPLv3

This is an API documentation of calls available to be made to any Flux.
GET Calls are available as both query and in order as path.
Flux is completely open source and we encourage everyone to feel free and contribute :)
Further questions or support join and ask in our discord

Flux

Introduction

Flux possesses a 5 tier hiearchy level API.

  • Public API level - Available without any permission, does not require signing.
  • User API level - User level permission, requires signing.
  • FluxTeam API level - FluxTeam level permission (an appointed Flux Team member has access to those API calls), requires signing.
  • Admin API level - Admin level permission, requires signing. Flux owner.
  • AdminAndFluxTeam API level permission (Admin and Flux Team has access to these calls), requires signing.
  • AppOwner API level - AppOwner level permission, requires signing. App Owner.
  • AppOwnerAbove API level - AppOwnerAbove level permission (App Owner, FluxTeam, and Admin has access to these calls), requires signing.

Most calls are available via GET request with some that may require large amount of data via POST request. Websocket is currently used only for simplifying login operations and for internal Flux communication.

Getting Started with the API

  • 1. Install Zelcore Wallet: The Zelcore wallet is required for signing messages. Please install this if not already installed.
  • 2. Create Zelcore Account: A Zelcore wallet account is required for signing messages. Please register an account if you don't already have one.
  • 3. Obtain API Authentication Credentials: Follow the Authentication section of this API documentation in order to set up your credentials for using the rest of the API. You will need to use your Zelcore wallet for parts of this process.
  • 4. Set Up Authentication Credentials in Header: Set up your zelidauth credentials in your header. If you are using variables, the signature value may need to be URLencoded.

Authentication

Calls that are neccessary to be made for correct signing into Flux and obtaining zelauth header.

Obtain login phrase

Obtain valid Login Phrase for signing into Flux. Login Phrase is at least 40 characters, first 13 characters is server timestamp and is valid for 15 minutes. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1574994809615gj4ct52kzz695twl0l27np0ivkmvu2ow4lbtpwk2nvf2k"
}

Login into Flux

Login into Flux by submitting correct ZelID, login phrase and signature. Note that to get the signature of the signed message you would need to do the signing on Zelcore or your BTC wallet or your ETH wallet. If success status response is returned, we can use the supplied data(zelid, loginPhrase, signature) as zelauth header as part of api calls that require a user to be logged in. Additionally it is possible to listen for a response on websocket. ws://{Flux_IP}:16127/ws/id/{loginPhrase}. Public

Request Body schema: text/plain
required

ZelID login object

loginPhrase
string >= 40 characters

Login Phrase. Provided by GET /id/loginphrase.

zelid
string [ 26 .. 35 ] characters

ZelID or any P2PKH bitcoin address or ethereum address

signature
string (signature)

Signature of signed loginPhrase with zelid.

Responses

Request samples

Content type
text/plain
{
  "loginPhrase": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba",
  "zelid": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC",
  "signature": "IAMZBB0p8aQ6A0Zt8uUKFLdWvPJlBypuczhaM6/R+s5bI72NQs/TPF1KYywvJlumMZyvLmk7JelDwaQbfTjqtSs="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Provide Signature

Provide requested signature from signed message to return data. Public

Request Body schema: text/plain
required
address
string

ZelID or any P2PKH Bitcoin address or Ethereum address

message
string

Login phrase message that was provided by GET /id/loginphrase

signature
string

Signature of signed loginPhrase with zelid/btc/eth address

Responses

Request samples

Content type
text/plain
{
  "address": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC",
  "message": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba",
  "signature": "IAMZBB0p8aQ6A0Zt8uUKFLdWvPJlBypuczhaM6/R+s5bI72NQs/TPF1KYywvJlumMZyvLmk7JelDwaQbfTjqtSs="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Logs out a specific session

Logs out a specific session. Requires the knowledge of a session loginPhrase and so users level is sufficient and user cannot logout another user as he does not know the loginPhrase. Admin can logout any specific session. User

Authorizations:
ZelID
Request Body schema: text/plain
required

Object containing loginPhrase

loginPhrase
string >= 40 characters

Login Phrase of session we want to log out.

Responses

Request samples

Content type
text/plain
{
  "loginPhrase": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

ID

Calls that interact with Identity via ZelID (BTC/ETH address) and login/authentication management of Flux

Obtain login phrase

Obtain valid Login Phrase for signing into Flux. Login Phrase is at least 40 characters, first 13 characters is server timestamp and is valid for 15 minutes. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1574994809615gj4ct52kzz695twl0l27np0ivkmvu2ow4lbtpwk2nvf2k"
}

Obtain emergency login phrase

Obtain emergency Login Phrase for signing into Flux. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1587939091067l06vdyv5wtl80q5aj0npi3vyyig869ogf7o7jxfpu68r"
}

Login into Flux

Login into Flux by submitting correct ZelID, login phrase and signature. Note that to get the signature of the signed message you would need to do the signing on Zelcore or your BTC wallet or your ETH wallet. If success status response is returned, we can use the supplied data(zelid, loginPhrase, signature) as zelauth header as part of api calls that require a user to be logged in. Additionally it is possible to listen for a response on websocket. ws://{Flux_IP}:16127/ws/id/{loginPhrase}. Public

Request Body schema: text/plain
required

ZelID login object

loginPhrase
string >= 40 characters

Login Phrase. Provided by GET /id/loginphrase.

zelid
string [ 26 .. 35 ] characters

ZelID or any P2PKH bitcoin address or ethereum address

signature
string (signature)

Signature of signed loginPhrase with zelid.

Responses

Request samples

Content type
text/plain
{
  "loginPhrase": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba",
  "zelid": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC",
  "signature": "IAMZBB0p8aQ6A0Zt8uUKFLdWvPJlBypuczhaM6/R+s5bI72NQs/TPF1KYywvJlumMZyvLmk7JelDwaQbfTjqtSs="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Provide Signature

Provide requested signature from signed message to return data. Public

Request Body schema: text/plain
required
address
string

ZelID or any P2PKH Bitcoin address or Ethereum address

message
string

Login phrase message that was provided by GET /id/loginphrase

signature
string

Signature of signed loginPhrase with zelid/btc/eth address

Responses

Request samples

Content type
text/plain
{
  "address": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC",
  "message": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba",
  "signature": "IAMZBB0p8aQ6A0Zt8uUKFLdWvPJlBypuczhaM6/R+s5bI72NQs/TPF1KYywvJlumMZyvLmk7JelDwaQbfTjqtSs="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Obtain all logged sessions of ZelID.

Gets all currently active logged sessions in Flux tied to given ZelID. User

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Logs out current session

This call logs out currently logged session which is determined by the supplied authentication header. User

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Logs out all sessions

This call logs out all logged sessions which are determined by the supplied authentication header. User

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Gets information about logged users

This call gets basic infromation about currently logged sessions of all users. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Lists active login phrases

This call gets a list of login phrases that are currently active (were generated less than 15 minutes ago) - phrases that have been used recently and phrases that can be used to log in.. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Logs out all users

This call logs out all logged users (including fluxteam, admins). Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Logs out a specific session

Logs out a specific session. Requires the knowledge of a session loginPhrase and so users level is sufficient and user cannot logout another user as he does not know the loginPhrase. Admin can logout any specific session. User

Authorizations:
ZelID
Request Body schema: text/plain
required

Object containing loginPhrase

loginPhrase
string >= 40 characters

Login Phrase of session we want to log out.

Responses

Request samples

Content type
text/plain
{
  "loginPhrase": "1575012988077darschvve5ag82g8e8sgeij4sn61842ya7ovxi9r3kba"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Checks the privilege level of user

Checks the privilege level of the user. The 5 levels are public, user, admin, flux team and app owner. User

Authorizations:
ZelID
Request Body schema: text/plain
required

Object containing privilege level

zelid
string

ZelID

signature
string

Signature of signed loginPhrase with ZelID

Responses

Request samples

Content type
text/plain
{
  "zelid": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC",
  "signature": "IAMZBB0p8aQ6A0Zt8uUKFLdWvPJlBypuczhaM6/R+s5bI72NQs/TPF1KYywvJlumMZyvLmk7JelDwaQbfTjqtSs="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Daemon

Calls that interact with locally running Flux daemon

RPC list

Gets list of RPC for the Flux daemon or if command query is used it will respond with the help info for that specified call. Public

query Parameters
command
string
Example: command=getmininginfo

Accepts both help/command and ?command=getinfo. If omited, default help will be displayed.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "== Addressindex == getaddressbalance {\"addresses\": [\"taddr\", ...]} getaddressdeltas {\"addresses\": [\"taddr\", ...], (\"start\": n), (\"end\": n), (\"chainInfo\": true|false)} getaddressmempool {\"addresses\": [\"taddr\", ...]} getaddresstxids {\"addresses\": [\"taddr\", ...], (\"start\": n), (\"end\": n)} getaddressutxos {\"addresses\": [\"taddr\", ...], (\"chainInfo\": true|false)}\n== Benchmarks == getbenchmarks getbenchstatus startfluxbenchd startzelbenchd stopfluxbenchd stopzelbenchd\n== Blockchain == getbestblockhash getblock \"hash|height\" ( verbosity ) getblockchaininfo getblockcount getblockdeltas \"blockhash\" getblockhash index getblockhashes high low ( {\"noOrphans\": true|false, \"logicalTimes\": true|false} ) getblockheader \"hash\" ( verbose ) getchaintips getdifficulty getmempoolinfo getrawmempool ( verbose ) getspentinfo {\"txid\": \"txidhex\", \"index\": n} gettxout \"txid\" n ( includemempool ) gettxoutproof [\"txid\",...] ( blockhash ) gettxoutsetinfo verifychain ( checklevel numblocks ) verifytxoutproof \"proof\"\n== Control == getinfo help ( \"command\" ) stop\n== Disclosure == z_getpaymentdisclosure \"txid\" \"js_index\" \"output_index\" (\"message\") z_validatepaymentdisclosure \"paymentdisclosure\"\n== Fluxnode == createfluxnodekey createzelnodekey fluxnodecurrentwinner getdoslist getfluxnodecount getfluxnodeoutputs getfluxnodestatus getmigrationcount getstartlist getzelnodecount getzelnodeoutputs getzelnodestatus listfluxnodeconf ( \"filter\" ) listfluxnodes ( \"filter\" ) listzelnodeconf ( \"filter\" ) listzelnodes ( \"filter\" ) startdeterministicfluxnode alias_name lockwallet startdeterministiczelnode alias_name lockwallet startfluxnode \"all|alias\" lockwallet ( \"alias\" ) startzelnode \"all|alias\" lockwallet ( \"alias\" ) viewdeterministicfluxnodelist ( \"filter\" ) viewdeterministiczelnodelist ( \"filter\" ) zelnodecurrentwinner\n== Generating == generate numblocks getgenerate setgenerate generate ( genproclimit )\n== Mining == getblocksubsidy height getblocktemplate ( \"jsonrequestobject\" ) getlocalsolps getmininginfo getnetworkhashps ( blocks height ) getnetworksolps ( blocks height ) prioritisetransaction <txid> <priority delta> <fee delta> submitblock \"hexdata\" ( \"jsonparametersobject\" )\n== Network == addnode \"node\" \"add|remove|onetry\" clearbanned disconnectnode \"node\" getaddednodeinfo dns ( \"node\" ) getconnectioncount getdeprecationinfo getnettotals getnetworkinfo getpeerinfo listbanned ping setban \"ip(/netmask)\" \"add|remove\" (bantime) (absolute)\n== Rawtransactions == createrawtransaction [{\"txid\":\"id\",\"vout\":n},...] {\"address\":amount,...} ( locktime ) ( expiryheight ) decoderawblock \"hexstring\" decoderawtransaction \"hexstring\" decodescript \"hex\" fundrawtransaction \"hexstring\" getrawtransaction \"txid\" ( verbose ) sendrawtransaction \"hexstring\" ( allowhighfees ) signrawtransaction \"hexstring\" ( [{\"txid\":\"id\",\"vout\":n,\"scriptPubKey\":\"hex\",\"redeemScript\":\"hex\"},...] [\"privatekey1\",...] sighashtype )\n== Util == createmultisig nrequired [\"key\",...] estimatefee nblocks estimatepriority nblocks printsnapshot \"time\" validateaddress \"fluxaddress\" verifymessage \"fluxaddress\" \"signature\" \"message\" z_validateaddress \"zaddr\"\n== Wallet == addmultisigaddress nrequired [\"key\",...] ( \"account\" ) backupwallet \"destination\" consolidateutxos (utxo_count) dumpprivkey \"t-addr\" dumpwallet \"folder/filename\" encryptwallet \"passphrase\" getaccount \"fluxaddress\" getaccountaddress \"account\" getaddressesbyaccount \"account\" getbalance ( \"account\" minconf includeWatchonly ) getnewaddress ( \"account\" ) getrawchangeaddress getreceivedbyaccount \"account\" ( minconf ) getreceivedbyaddress \"fluxaddress\" ( minconf ) gettransaction \"txid\" ( includeWatchonly ) getunconfirmedbalance getwalletinfo importaddress \"address\" ( \"label\" rescan ) importprivkey \"zelcashprivkey\" ( \"label\" rescan ) importwallet \"filename\" keypoolrefill ( newsize ) listaccounts ( minconf includeWatchonly) listaddressgroupings listlockunspent listreceivedbyaccount ( minconf includeempty includeWatchonly) listreceivedbyaddress ( minconf includeempty includeWatchonly) listsinceblock ( \"blockhash\" target-confirmations includeWatchonly) listtransactions ( \"account\" count from includeWatchonly) listunspent ( minconf maxconf [\"address\",...] ) lockunspent unlock [{\"txid\":\"txid\",\"vout\":n},...] move \"fromaccount\" \"toaccount\" amount ( minconf \"comment\" ) rescanblockchain (start_height) sendfrom \"fromaccount\" \"tofluxaddress\" amount ( minconf \"comment\" \"comment-to\" ) sendmany \"fromaccount\" {\"address\":amount,...} ( minconf \"comment\" [\"address\",...] ) sendtoaddress \"fluxaddress\" amount ( \"comment\" \"comment-to\" subtractfeefromamount ) setaccount \"fluxaddress\" \"account\" settxfee amount signmessage \"t-addr\" \"message\" z_exportkey \"zaddr\" z_exportviewingkey \"zaddr\" z_exportwallet \"folder/filename\" z_getbalance \"address\" ( minconf ) z_getmigrationstatus z_getnewaddress ( type ) z_getoperationresult ([\"operationid\", ... ]) z_getoperationstatus ([\"operationid\", ... ]) z_gettotalbalance ( minconf includeWatchonly ) z_importkey \"zkey\" ( rescan startHeight ) z_importviewingkey \"vkey\" ( rescan startHeight ) z_importwallet \"filename\" z_listaddresses ( includeWatchonly ) z_listoperationids z_listreceivedbyaddress \"address\" ( minconf ) z_listunspent ( minconf maxconf includeWatchonly [\"zaddr\",...] ) z_mergetoaddress [\"fromaddress\", ... ] \"toaddress\" ( fee ) ( transparent_limit ) ( shielded_limit ) ( memo ) z_sendmany \"fromaddress\" [{\"address\":... ,\"amount\":...},...] ( minconf ) ( fee ) z_setmigration enabled z_shieldcoinbase \"fromaddress\" \"tozaddress\" ( fee ) ( limit ) zcbenchmark benchmarktype samplecount zcrawjoinsplit rawtx inputs outputs vpub_old vpub_new zcrawkeygen zcrawreceive zcsecretkey encryptednote zcsamplejoinsplit"
}

Flux daemon info

Returns an object containing various state info for the Flux daemon. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Flux node status

Returns an object containing various state of the Flux node. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Flux node list

Gets a ranked list of Flux nodes. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Deterministic FluxNode list

View deterministic list of FluxNodes by rank. Public

query Parameters
filter
string
Example: filter=193.188.15.238

Accepts both viewdeterministicfluxnodelist/filter and ?filter=193.188.15.238. Filter query will filter list by ,txhash, payment address, ip, or pubkey. If ommited, full list will be displayed.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Flux node count

Returns a count of FluxNodes and enabled FluxNodes categorized by tiers. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxNode DOS list

Get a list of all fluxnodes in the DOS list. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

FluxNode start list

Get a list of all Fluxnodes in the start list. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Current list of winners

Gets a list of current FluxNode winners. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Block hash of tip on longest chain

Returns the hash of the best (tip) block in the longest block chain. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "00000045ee2d11311976f420b0d753dc7a6e2800a36cf07f6ec1572699737ab6"
}

Get block data

Gets block data using block height or block hash you specify to get info for with verbosity option. Public

query Parameters
hashheight
required
integer
Example: hashheight=588530

Block hash or height

verbosity
integer
Default: 1
Enum: 0 1 2
Example: verbosity=1

If verbosity is 0, returns a string that is serialized, hex-encoded data for the block. If verbosity is 1, returns an Object with information about the block. If verbosity is 2, returns an Object with information about the block and information about each transaction. Response example shown is using the default value of 1.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Blockchain info

Returns an object containing various state info regarding block chain processing. Note that when the chain tip is at the last block before a network upgrade activation, consensus.chaintip != consensus.nextblock. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Current block count

Returns the number of blocks in the best valid block chain. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 1410823
}

Get block deltas data

Returns data of block deltas. Public

query Parameters
hash
required
string
Example: hash=000000234b617194f3faff69ee62f0dde0115f2007c3b42e38eaba80c786a5e5

Block hash

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get block's hash

Returns hash of block in best-block-chain at index provided. Public

query Parameters
index
required
number
Example: index=590823

Block number to get hash of

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "000000234b617194f3faff69ee62f0dde0115f2007c3b42e38eaba80c786a5e5"
}

Block header info

Returns an Object with information about blockheader. Public

query Parameters
hash
required
string
Example: hash=000000234b617194f3faff69ee62f0dde0115f2007c3b42e38eaba80c786a5e5

Block hash to get header info from

verbose
boolean
Default: true
Enum: true false

If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. If verbose is true, returns an Object with information about blockheader hash.

Example:

  • hash=<block hash>&verbose=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

List of known chain tips

Return information about all known tips in the block tree, including the main chain as well as orphaned branches. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Proof of work difficulty

Returns the proof-of-work difficulty as a multiple of the minimum difficulty. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 2572.645186022886
}

Memory pool info

Returns details on the active state of the TX memory pool. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Transaction ids in memory pool

Returns all transaction ids in memory pool as a json array of string. Public

query Parameters
verbose
boolean
Default: false
Enum: true false

True for a json object, false for array of transaction ids.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Transaction IDs in memory pool

Returns all transaction ids in memory pool as a json array of string. Public

query Parameters
txid
required
string
Example: txid=9e3cdde1b7c92728a1200a988bb046028fe93b9f1e15cc370974f7201d3d3a94

The transaction id

n
required
integer
Example: n=1

Vout value

includemempool
boolean
Default: false
Enum: true false

Whether to include the mempool.

Example:

  • txid=<transaction id>&n=<vout value>&includemempool=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Hex-encoded proof of transaction

Returns a hex-encoded proof that "txid" was included in a block. Public

query Parameters
txids
required
string
Example: txids=9e3cdde1b7c92728a1200a988bb046028fe93b9f1e15cc370974f7201d3d3a94

The transaction id or comma separated list of txids

blockhash
string
Example: blockhash=000000142fc5a382f6db5895faa7e9519721be67560cfd0c2171634d541bc38e

If specified, looks for txid in the block with this hash

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "04000000e6f6eb7762f7970a06ad119590ba1882a30e290e3f6837cc64960f1b70000000fde035a9548fe35311b0212323eeeb9844c9ab093b24982d397fd94ab68f68725f44c0da150b3d68af0671dc272b007c4354a03d63298b00ad7700d4b818f70a4d0ab05eaca2001e0001b8750000000000000000000000000000000000000000000000003eae1205340a77b45fde07253220864115fe31c3a77f1e84b358edafad9929200de7c90f8d38878f423f9dc35266b6fd8280e56d3615b988540100000001fde035a9548fe35311b0212323eeeb9844c9ab093b24982d397fd94ab68f68720101"
}

Unspent transaction output set info

Returns statistics about the unspent transaction output set. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Verifies a proof

Verifies that a proof points to a transaction in a block, returning the transaction it commits to and throwing an RPC error if the block is not in our best chain. Public

query Parameters
proof
required
string
Example: proof=04000000e6f6eb7762f7970a06ad119590ba1882a30e290e3f6837cc64960f1b70000000fde035a9548fe35311b0212323eeeb9844c9ab093b24982d397fd94ab68f68725f44c0da150b3d68af0671dc272b007c4354a03d63298b00ad7700d4b818f70a4d0ab05eaca2001e0001b8750000000000000000000000000000000000000000000000003eae1205340a77b45fde07253220864115fe31c3a77f1e84b358edafad9929200de7c90f8d38878f423f9dc35266b6fd8280e56d3615b988540100000001fde035a9548fe35311b0212323eeeb9844c9ab093b24982d397fd94ab68f68720101

The hex-encoded proof generated by gettxoutproof

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Return spent info

Return spent info. Transaction ID and index required as parameters. Public

query Parameters
txid
required
string
Example: txid=9e3cdde1b7c92728a1200a988bb046028fe93b9f1e15cc370974f7201d3d3a94

The transaction id

index
required
integer

index

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Block reward

Returns block subsidy reward, taking into account the mining slow start of block at index provided. Public

query Parameters
height
string
Example: height=575000

The block height. If not provided, defaults to the current height of the chain.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Data to construct a block

It returns data needed to construct a block to work on. Public

query Parameters
object
Example: mode=template&capabilities=proposal

If the request parameters include a 'mode' key, that is used to explicitly select between the default template request or a proposal. This must be set to "template" or omitted.

For the capabilities array of strings the following are the client side supported features.

  • longpoll
  • coinbasetxn
  • coinbasevalue
  • proposal
  • serverlist
  • workid

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Average solutions per second

Returns the average local solutions per second since this node was started. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Mining related info

Returns a json object containing mining-related information. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Estimated network solutions

Returns the estimated network solutions per second based on the last n blocks. Public

query Parameters
blocks
integer
Default: 120
Example: blocks=200

The number of blocks, or -1 for blocks over difficulty averaging window.

height
integer
Default: 1
Example: height=575000

To estimate at the time of the given height.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 189503
}

Estimated network solutions

Returns the estimated network solutions per second based on the last n blocks. Public

query Parameters
blocks
integer
Default: 120
Example: blocks=200

The number of blocks, or -1 for blocks over difficulty averaging window.

height
integer
Default: 1
Example: height=575000

To estimate at the time of the given height.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 189503
}

Connection count

The peer connection count. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 22
}

Deprecation info

Returns an object containing current version and deprecation block height. Applicable only on mainnet. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Network traffic info

Returns information about network traffic, including bytes in, bytes out, and current time. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Info regarding P2P network

Returns an object containing various state info regarding P2P networking. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Peer info

Returns data about each connected network node as a json array of objects. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Ban list

List all banned IPs/Subnets. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create raw transaction (GET)

Create a raw transaction using path parameters. Public

query Parameters
transactions
required
string

JSON string of transaction inputs

addresses
required
string

JSON string of output addresses and amounts

locktime
integer

Transaction locktime

expiryheight
integer

Transaction expiry height

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "string"
}

Create hex-encoded raw transaction

Create a transaction spending the given inputs and sending to the given addresses. Returns hex-encoded raw transaction. Note that the transaction's inputs are not signed, and it is not stored in the wallet or transmitted to the network. Public

Request Body schema: text/plain
required
Array of objects
addresses
object

Object with addresses as keys and amounts as values

locktime
integer
Default: 0

Raw locktime. Non-0 value also locktime-activates inputs. (optional)

expiryheight
string
Default: "Nextblockheight+20"

Expiry height of transaction (optional)

Responses

Request samples

Content type
text/plain
{
  "transactions": [
    {
      "txid": "224225b04fd54e8653e7cd4440dd4596aab6eff8be8686bacfad9213172da4369f",
      "vout": 0
    }
  ],
  "addresses": {
    "t1JKRwXGfKTGfPV1z48rvoLyabk31z3xwHa": 112.5
  },
  "locktime": 10,
  "expiryheight": 595000
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "0400008085202f89019f36a42d171392adcfba8686bef8efb6aa9645dd4044cde753864ed54fb025420000000000feffffff0180608d9e020000001976a91404e2699cec5f44280540fb752c7660aa3ba857cc88ac01000000fb0809000000000000000000000000"
}

Decoded info of the hex-encoded transaction

Return a JSON object representing the serialized, hex-encoded transaction. Public

Request Body schema: text/plain
required
hexstring
string

Hex-encoded transaction

Responses

Request samples

Content type
text/plain
{
  "hexstring": "0400008085202f89019f36a42d171392adcfba8686bef8efb6aa9645dd4044cde753864ed54fb025420000000000feffffff0180608d9e020000001976a91404e2699cec5f44280540fb752c7660aa3ba857cc88ac01000000fb0809000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Decoded info of the hex-encoded transaction

Return a JSON object representing the serialized, hex-encoded transaction. Public

query Parameters
hexstring
required
string
Example: hexstring=0400008085202f89019f36a42d171392adcfba8686bef8efb6aa9645dd4044cde753864ed54fb025420000000000feffffff0180608d9e020000001976a91404e2699cec5f44280540fb752c7660aa3ba857cc88ac01000000fb0809000000000000000000000000

Hex-encoded transaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Decode hex script

Decode a hex-encoded script. Public

Request Body schema: text/plain
required
hex
string

Hex-encoded transaction

Responses

Request samples

Content type
text/plain
{
  "hex": "76a91404e2699cec5f44280540fb752c7660aa3ba857cc88ac"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Decode hex script

Decode a hex-encoded script. Public

query Parameters
hex
required
string
Example: hex=76a91404e2699cec5f44280540fb752c7660aa3ba857cc88ac

Hex-encoded transaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get raw transaction data

Gets raw transaction data from the txid, if verbose=0 then only hex data of transaction is shown, if verbose=1 then it will return with object of info of txid. Public

query Parameters
txid
required
string
Example: txid=1ed830027683e98c5670981ee983860485fce5132f30d9b6e8e248789c52c55d

Txid to get raw tx data from

verbose
number
Default: 0
Example: verbose=1

If verbose is not set or at 0 only hex-encoded data for the txid will return but if set at 1 it will return an object with info of the txid.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Add inputs to a transaction

Add inputs to a transaction until it has enough in value to meet its out value. This will not modify existing inputs, and will add one change output to the outputs. Note that inputs which were signed may need to be resigned after completion since in/outputs have been added. The inputs added will not be signed, use signrawtransaction for that. Public

Request Body schema: text/plain
required
hex
string

Hex-encoded transaction

Responses

Request samples

Content type
text/plain
{
  "hexstring": "0400008085202f8901ab719872dfea1b4f594049722a92efafa4695322d2c08654aafe98c6546066360000000000ffffffff0140420f00000000001976a9142e5db3157a9783c6208019323f2c3a02610826a988ac00000000a60a09000000000000000000000000"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Add inputs to a transaction

Add inputs to a transaction until it has enough in value to meet its out value. This will not modify existing inputs, and will add one change output to the outputs. Note that inputs which were signed may need to be resigned after completion since in/outputs have been added. The inputs added will not be signed, use signrawtransaction for that. Public

query Parameters
hexstring
required
string
Example: hexstring=0400008085202f8901ab719872dfea1b4f594049722a92efafa4695322d2c08654aafe98c6546066360000000000ffffffff0140420f00000000001976a9142e5db3157a9783c6208019323f2c3a02610826a988ac00000000a60a09000000000000000000000000

Hex string of raw transaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Send raw transaction

Submits raw transaction (serialized, hex-encoded) to local node and network. Also see createrawtransaction and signrawtransaction calls. Public

Request Body schema: text/plain
required
hexstring
string

Hex-encoded transaction

allowhighfees
boolean
Default: false

Allow high fees (optional)

Responses

Request samples

Content type
text/plain
{
  "hexstring": "0400008085202f8901ab719872dfea1b4f594049722a92efafa4695322d2c08654aafe98c654606636000000006b483045022100e5f02014419280a5c1ed1f94513e8e2bee83f6341863b304fe093dea897f4aa20220022a6e6004dbf1305197f4053bd9dd59e21abd23a31d0188d079eb72cab84e990121036b6a136ce869a0b400548a9126f06d96181ee974ff1c7f5a5e54e39b7f66be05ffffffff0140420f00000000001976a9142e5db3157a9783c6208019323f2c3a02610826a988ac00000000a60a09000000000000000000000000",
  "allowhighfees": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "381bfe56a049208ff90356153f024395b7a74b5ec470d639dd7e6ffa4487b2fe"
}

Send raw transaction

Submits raw transaction (serialized, hex-encoded) to local node and network. Also see createrawtransaction and signrawtransaction calls. Public

query Parameters
hexstring
required
string
Example: hexstring=0400008085202f8901ab719872dfea1b4f594049722a92efafa4695322d2c08654aafe98c654606636000000006b483045022100e5f02014419280a5c1ed1f94513e8e2bee83f6341863b304fe093dea897f4aa20220022a6e6004dbf1305197f4053bd9dd59e21abd23a31d0188d079eb72cab84e990121036b6a136ce869a0b400548a9126f06d96181ee974ff1c7f5a5e54e39b7f66be05ffffffff0140420f00000000001976a9142e5db3157a9783c6208019323f2c3a02610826a988ac00000000a60a09000000000000000000000000

The hex string of the raw transaction

allowhighfees
boolean
Default: false
Enum: true false

Allow high fees.

  • hexstring=<Hex string of raw tx>&allowhighfees=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "381bfe56a049208ff90356153f024395b7a74b5ec470d639dd7e6ffa4487b2fe"
}

Create multi-sig address

Creates a multi-signature address with n signature of n keys required. Public

Request Body schema: text/plain
required
n
integer

The number of required signatures out of the n keys or addresses. Followed by Flux addresses in array of strings.

keys
Array of strings

Array of keys which are Flux addresses or hex-encoded public keys

Responses

Request samples

Content type
text/plain
{
  "n": 2,
  "keys": [
    "t1XcXfRFSnSeYmf2mbsMHzHbV8Qo5Zhk817",
    "t1RAxsCaeeqB2XbZqvYU87uTMo9K2RtcA9z"
  ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create multi-sig address

Creates a multi-signature address with n signature of n keys required. Public

query Parameters
n
required
integer
Example: n=2

The number of required signatures out of the n keys or addresses. Followed by Flux addresses in array of strings.

keys
required
Array of strings

A json array of keys which are Flux addresses or hex-encoded public keys.

Example:

  • ["t1XcXfRFSnSeYmf2mbsMHzHbV8Qo5Zhk817","t1RAxsCaeeqB2XbZqvYU87uTMo9K2RtcA9z"]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Estimate fee nblocks

Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within nblocks blocks. Public

query Parameters
nblocks
required
integer
Example: nblocks=5

Number of nblocks

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": -1
}

Estimate priority nblocks

Estimates the approximate priority a zero-fee transaction needs to begin confirmation within nblocks blocks. Public

query Parameters
nblocks
required
integer
Example: nblocks=5

Number of nblocks

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Info of the Flux address

Return information about the given Flux address. Public

query Parameters
fluxaddress
required
string
Example: fluxaddress=t1N6mLX2A64QsyuLbYkfPZSrkLF86hxuuFe

Flux address to validate

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Verify a message

Verify a signed message. Public

Request Body schema: text/plain
required
fluxaddress
string

The Flux address to use for the signature

signature
string

The signature provided by the signer in base 64 encoding

message
string

The message that was signed

Responses

Request samples

Content type
text/plain
{
  "fluxadress": "t1N6mLX2A64QsyuLbYkfPZSrkLF86hxuuFe",
  "signature": "H5j8AoJ+8VaEEJGgw846hSPQoq42X9yiLwn/Nab1pASBFcw8rj5k8J9xpKr1VzepMEOF2ProYxVsQ9i7xalH4Sk=",
  "message": "helloworld"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Verify a message

Verify a signed message. Public

query Parameters
fluxaddress
required
string
Example: fluxaddress=t1N6mLX2A64QsyuLbYkfPZSrkLF86hxuuFe

The Flux address to use for the signature

signature
required
string
Example: signature=H5j8AoJ+8VaEEJGgw846hSPQoq42X9yiLwn/Nab1pASBFcw8rj5k8J9xpKr1VzepMEOF2ProYxVsQ9i7xalH4Sk=

The signature provided by the signer in base 64 encoding

message
required
string
Example: message=helloworld

The message that was signed

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Information about in-wallet transaction

Get detailed information about in-wallet transaction. Public

query Parameters
txid
required
string
Example: txid=36666054c698feaa5486c0d2225369a4afef922a724940594f1beadf729871ab

The transaction id

includewatchonly
boolean
Default: false
Enum: true false

Whether to include watchonly addresses in balance calculation and details.

Example:

  • txid=<transaction id>&includewatchonly=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Information about given z address

Return information about the given z address. Public

query Parameters
zaddr
required
string
Example: zaddr=za102nkanf5xu6asasvydwp3zlcuure23jqxxz0zqh9catfvc9cu0dfcvl35tz3qkf2q2cxc47g4mk

The z address to validate

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Benchmark results

Return most recent benchmark results. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Bench status

This will return the status of the node, what fluxbenchd determined the tier the server could pass for, and if Flux backend is connected. If any one of these return a negative result the FluxNode will fail to confirm. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get block hashes

Returns array of block hashes for given height range. Public

query Parameters
high
integer

Ending block height

low
integer

Starting block height

noorphans
boolean

Exclude orphan blocks

logicaltimes
boolean

Include logical times

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get block hashes (POST)

Returns array of block hashes for given height range. Public

Request Body schema: application/json
required
high
integer

Ending block height

low
integer

Starting block height

noorphans
boolean

Exclude orphan blocks

logicaltimes
boolean

Include logical times

Responses

Request samples

Content type
application/json
{
  • "high": 0,
  • "low": 0,
  • "noorphans": true,
  • "logicaltimes": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address transaction IDs

Get all transaction IDs for a specific address. Admin

Authorizations:
ZelID
query Parameters
address
required
string

Flux address to query

start
integer

Starting block height

end
integer

Ending block height

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address transaction IDs (POST)

Get all transaction IDs for multiple addresses. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
addresses
Array of strings

Array of Flux addresses

start
integer

Starting block height

end
integer

Ending block height

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ],
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address balance

Get balance for a specific address. Admin

Authorizations:
ZelID
query Parameters
address
required
string

Flux address to query

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get address balance (POST)

Get balance for multiple addresses. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
addresses
Array of strings

Array of Flux addresses

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address deltas

Get balance changes (deltas) for a specific address. Admin

Authorizations:
ZelID
query Parameters
address
required
string

Flux address to query

start
integer

Starting block height

end
integer

Ending block height

chaininfo
boolean

Include chain information

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address deltas (POST)

Get balance changes for multiple addresses. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
addresses
Array of strings
start
integer
end
integer
chaininfo
boolean

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ],
  • "start": 0,
  • "end": 0,
  • "chaininfo": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address UTXOs

Get unspent transaction outputs for a specific address. Admin

Authorizations:
ZelID
query Parameters
address
required
string

Flux address to query

chaininfo
boolean

Include chain information

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address UTXOs (POST)

Get UTXOs for multiple addresses. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
addresses
Array of strings
chaininfo
boolean

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ],
  • "chaininfo": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address mempool transactions

Get mempool transactions for a specific address. Admin

Authorizations:
ZelID
query Parameters
address
required
string

Flux address to query

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get address mempool (POST)

Get mempool transactions for multiple addresses. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
addresses
Array of strings

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Send from account

Send Flux from a specific account to an address. Admin

Authorizations:
ZelID
query Parameters
tofluxaddress
required
string

Destination Flux address

amount
required
number

Amount to send

minconf
integer
Default: 1

Minimum confirmations

comment
string

Transaction comment

commentto
string

Comment for recipient

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "string"
}

Send from account (POST)

Send Flux from account using POST method. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
tofluxaddress
required
string
amount
required
number
minconf
integer
comment
string
commentto
string

Responses

Request samples

Content type
application/json
{
  • "tofluxaddress": "string",
  • "amount": 0,
  • "minconf": 0,
  • "comment": "string",
  • "commentto": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "string"
}

Submit block

Submit a block to the network. User

Authorizations:
ZelID
query Parameters
hexdata
required
string

Block data in hex format

jsonparametersobject
string

Optional JSON parameters

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "string"
}

Submit block (POST)

Submit a block using POST method. User

Authorizations:
ZelID
Request Body schema: application/json
required
hexdata
required
string
jsonparametersobject
string

Responses

Request samples

Content type
application/json
{
  • "hexdata": "string",
  • "jsonparametersobject": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "string"
}

ZCash raw joinsplit

Create a raw joinsplit transaction. Admin

Authorizations:
ZelID
query Parameters
rawtx
required
string

Raw transaction hex

inputs
required
string

JSON string of inputs

outputs
required
string

JSON string of outputs

vpubold
required
number

Public input value

vpubnew
required
number

Public output value

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": { }
}

ZCash raw joinsplit (POST)

Create raw joinsplit using POST method. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
rawtx
required
string
inputs
required
string
outputs
required
string
vpubold
required
number
vpubnew
required
number

Responses

Request samples

Content type
application/json
{
  • "rawtx": "string",
  • "inputs": "string",
  • "outputs": "string",
  • "vpubold": 0,
  • "vpubnew": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": { }
}

ZCash raw receive

Decrypt and return information about a note. Admin

Authorizations:
ZelID
query Parameters
zcsecretkey
required
string

Secret key for decryption

encryptednote
required
string

Encrypted note hex

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": { }
}

ZCash raw receive (POST)

Decrypt note using POST method. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
zcsecretkey
required
string
encryptednote
required
string

Responses

Request samples

Content type
application/json
{
  • "zcsecretkey": "string",
  • "encryptednote": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": { }
}

Priortise a transaction

Accepts the transaction into mined blocks at a higher (or lower) priority. User

Authorizations:
ZelID
query Parameters
txid
required
string
Example: txid=22ab3d049154c7d4b0f04b381770c655564facdc896a4f7e97aa5662f57a58c6

The transaction id

prioritydelta
required
integer

The priority to add or subtract. The transaction selection algorithm considers the tx as it would have a higher priority. (priority of a transaction is calculated: coinage * value_in_satoshis / txsize)

feedelta
required
integer
Example: feedelta=10000

The fee value (in satoshis) to add (or subtract, if negative). The fee is not actually paid, only the algorithm for selecting transactions into a block considers the transaction as it would have paid a higher (or lower) fee.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Reindex Flux daemon

Tries to reindex Flux daemon running on the FluxNode the call is run against. Flux daemon is firstly stopped and then started with reindex flag. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Stop Flux daemon

This will stop the Flux daemon from running. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Stop Flux server"
}

Create fluxnode private key

Create a new fluxnode private key. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "5JwVKe7UH986ncSL2jG9KdUY2AuZUTDAkTsp4TZoGWdD5cLLiFR"
}

The fluxnode conf file

View fluxnode conf file in JSON format, this will return empty for most unless running a hot wallet. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Fluxnode transaction outputs

Print all fluxnode transaction outputs. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Start FluxNode commmand

Attempts to start one or more FluxNode. This call will only work if running a hot FluxNode which is highly not recommended. It is a control wallet function so basically your wallet containing the collateral funds. Admin

Authorizations:
ZelID
query Parameters
set
required
string
Example: set=alias

Specify which set of FluxNode(s) to start.

lockwallet
required
boolean
Enum: true false

Lock wallet after completion.

Example:

  • set=<alias>&lockwallet=false
alias
required
string
Example: alias=Super1

FluxNode alias. Required if using 'alias' as the set.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Start fluxnode command

Attempts to start one fluxnode. Same as the /daemon/startfluxnode call this call will only work if running a hot FluxNode which is highly not recommended. It is a control wallet function so basically your wallet containing the collateral funds. Admin

Authorizations:
ZelID
query Parameters
alias
required
string
Example: alias=Basic1

Node name or alias.

lockwallet
required
boolean
Enum: true false

Lock wallet after completion.

Example:

  • alias=<alias&lockwallet=false

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Verify blockchain data

Verifies blockchain database. Admin

Authorizations:
ZelID
query Parameters
checklevel
integer
Default: 3
Enum: 0 1 2 3 4

How thorough the block verification is.

Example:

  • checklevel=1
numblocks
integer
Default: 288
Example: numblocks=200

The number of blocks to check

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Add, remove, or try to connect a node

Attempts to add or remove a node from the addnode list. Or try a connection to a node once. Admin

Authorizations:
ZelID
query Parameters
node
required
string
Example: node=188.239.61.210:16125

The node's ip:port (see /daemon/getpeerinfo for nodes)

command
required
string
Enum: "add" "remove" "onetry"

Use 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once.

Example:

  • node=<ip:port>&command=add

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Clear banned IP's

Clear all banned IP's. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Disconnect a node

Immediately disconnects from the specified node. Admin

Authorizations:
ZelID
query Parameters
node
required
string
Example: node=188.239.61.210:16125

The node's ip:port

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Info of added node/nodes

Returns information about the given added node, or all added nodes(note that onetry addnodes are not listed here). If dns is false, only a list of added nodes will be provided, otherwise connected information will also be available. Admin

Authorizations:
ZelID
query Parameters
dns
required
boolean
Enum: true false

If false, only a list of added nodes will be provided, otherwise connected information will also be available.

node
string
Example: node=188.239.61.210:16125

The node ip:port

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Add or remove a IP from banned list

Attempts add or remove a IP/Subnet from the banned list. Admin

Authorizations:
ZelID
query Parameters
ip
required
string
Example: ip=188.239.61.210

The IP/Subnet (see getpeerinfo for nodes ip) with a optional netmask (default is /32 = single ip)

command
required
string
Enum: "add" "remove"

Use 'add' to add a IP/Subnet to the list, 'remove' to remove a IP/Subnet from the list

bantime
integer
Default: 86400
Example: bantime=3500

Time in seconds how long (or until when if absolute is set) the ip is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument)

absolute
boolean
Enum: false true

If set, the bantime must be a absolute timestamp in seconds since epoch (Jan 1 1970 GMT)

Example:

  • ip=<ipaddress>&command=<add/remove>&bantime=1590368400&absolute=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Sign raw transaction

Sign inputs for raw transaction (serialized, hex-encoded). The second optional argument (may be null) is an array of previous transaction outputs that this transaction depends on but may not yet be in the block chain. The third optional argument (may be null) is an array of base58-encoded private keys that, if given, will be the only keys used to sign the transaction. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
hexstring
string

Hex string of raw transaction

Array of objects

An json array of previous dependent transaction outputs (json array of json objects, or null if none provided). (optional)

privatekeys
Array of strings

A json array of base58-encoded private keys for signing (optional)

sighashtype
string
Default: "ALL"
Enum: "ALL" "NONE" "SINGLE" "ALL|ANYONECANPAY" "NONE|ANYONECANPAY" "SINGLE|ANYONECANPAY"

The signature hash type. Must be one of the available values listed. (optional)

branchid
string

The hex representation of the consensus branch id to sign with. This can be used to force signing with consensus rules that are ahead of the node's current height. (optional)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Sign raw transaction

Sign inputs for raw transaction (serialized, hex-encoded). The second optional argument (may be null) is an array of previous transaction outputs that this transaction depends on but may not yet be in the block chain. The third optional argument (may be null) is an array of base58-encoded private keys that, if given, will be the only keys used to sign the transaction. Admin

Authorizations:
ZelID
query Parameters
hexstring
required
string
Example: hexstring=0400008085202f8901ab719872dfea1b4f594049722a92efafa4695322d2c08654aafe98c6546066360000000000ffffffff0140420f00000000001976a9142e5db3157a9783c6208019323f2c3a02610826a988ac00000000a60a09000000000000000000000000

Hex string of raw transaction

Array of objects

An json array of previous dependent transaction outputs (json array of json objects, or null if none provided).

List of objects key/value pairs in order:

  • txid:<transaction id>
  • vout:<output index>
  • scriptPubKey:<script key>
  • redeemScript:<redeem script>
  • amount:<the amount spent>
privatekeys
Array of strings

A json array of base58-encoded private keys for signing (json array of strings, or null if none provided).

sighashtype
string
Default: "ALL"
Enum: "ALL" "NONE" "SINGLE" "ALL|ANYONECANPAY" "NONE|ANYONECANPAY" "SINGLE|ANYONECANPAY"

The signature hash type. Must be one of the available values listed.

branchid
string

The hex representation of the consensus branch id to sign with. This can be used to force signing with consensus rules that are ahead of the node's current height.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Add multisig address to the wallet

Add a nrequired-to-sign multisignature address to the wallet. Each key is a Flux address or hex-encoded public key. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
n
string

The number of required signatures out of the n keys or addresses

keysobject
Array of strings

A json array of Flux addresses or hex-encoded public keys.

Responses

Request samples

Content type
text/plain
{
  "n": 2,
  "keysobject": [
    "t1b4SUue7q26dADLGUyFBu57uJsKS7jc8VC",
    "t1TtEnZKBziV5LziBXr9KvrYC2HbQA91rSN"
  ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "t3Sia7BaQ6cYYxj31PJWfxhwZwZozNzk9N7"
}

Add multisig address to the wallet

Add a nrequired-to-sign multisignature address to the wallet. Each key is a Flux address or hex-encoded public key. Admin

Authorizations:
ZelID
query Parameters
n
required
integer
Example: n=2

The number of required signatures out of the n keys or addresses

keysobject
required
Array of strings

A json array of Flux addresses or hex-encoded public keys.

Example:

  • keysobject=[<"address">, <"address">]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "t3Sia7BaQ6cYYxj31PJWfxhwZwZozNzk9N7"
}

Backup wallet to destination file

Safely copies wallet.dat to destination filename. Admin

Authorizations:
ZelID
query Parameters
destination
required
string
Example: destination=walletbackup

The destination filename, saved in the directory set by -exportdir option

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "/home/user/backup/walletbackup"
}

Get private key of a t-addr

Reveals the private key corresponding to t-addr. Admin

Authorizations:
ZelID
query Parameters
taddr
required
string
Example: taddr=t1LGoWfLf66bpJC84zWmUd9i1bkW9kFgnyQ

The transparent address for the private key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "KyqvmC4mDgxwnKjfGYPVt1wonwog4kZ8oA8WsL5yr7vE2X5phxwx"
}

Total balance of wallet

Returns the server's total available balance. Admin

Authorizations:
ZelID
query Parameters
minconf
integer
Default: 1
Example: minconf=5

Only include transactions confirmed at least this many times

includewatchonly
boolean
Default: false
Enum: true false

Also include balance in watchonly addresses.

Example:

  • includewatchonly=true

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Get new address

Returns a new Flux address for receiving payments. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "t1LGoWfLf66bpJC84zWmUVcw1bkW9kFgnyQ"
}

Get new change address

Returns a new Flux address, for receiving change. This is for use with raw transactions, NOT normal use. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "t1dC6WNjqcJX8VFcdRp1MyJ7eB4MSQs83FR"
}

Total received by the address

Returns the total amount received by the given Flux address in transactions with at least minconf confirmations. Admin

Authorizations:
ZelID
query Parameters
fluxaddress
required
string
Example: fluxaddress=t1dC6WNjqcJX8VFcdRp1MyJ7eB4MSQs83FR

The Flux address for transactions

minconf
integer
Default: 1
Example: minconf=5

Only include transactions confirmed at least this many times

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Get total unconfirmed balance

Returns the server's total unconfirmed balance. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Get various info of the wallet

Returns an object containing various wallet state info. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Import address to watch

Adds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Admin

Authorizations:
ZelID
query Parameters
address
required
string
Example: address=t1dC6WNjqcJX8VFcdRp1MyJ7eB4MSQs83FR

The Flux address

label
string
Default: "\"\""
Example: label=watchonly

Optional label

rescan
boolean
Default: true
Enum: true false

Rescan the wallet for transactions (This call can take some time to complete if rescan is true)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Import private key to the wallet

Adds a private key (as returned by dumpprivkey) to your wallet. Admin

Authorizations:
ZelID
query Parameters
fluxprivkey
required
string
Example: fluxprivkey=KyqvmC4mDgxwnKjfGYPVt1wonwog4kZ8oA8WsL5yr7vE2X5phxwx

The private key

label
string
Default: "\"\""
Example: label=import1

Optional label

rescan
boolean
Default: true
Enum: true false

Rescan the wallet for transactions (This call can take some time to complete if rescan is true)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Import private keys from the dump file

Imports taddr keys from a wallet dump file. Admin

Authorizations:
ZelID
query Parameters
filename
required
string
Example: filename=dumpwallet

The name of backup

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Refill keypool

Fills the keypool with more keys. Rarely used as not many will come close to using more than it comes with by default. Admin

Authorizations:
ZelID
query Parameters
newsize
required
integer
Example: newsize=150

The new keypool size

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

A list of addresses that have been used and known to the public

Lists groups of addresses which have had their common ownership made public by common use as inputs or as the resulting change in past transactions. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of unspendable outputs

Returns list of temporarily unspendable outputs. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of balances

List balances by receiving address. Admin

Authorizations:
ZelID
query Parameters
minconf
integer
Default: 1
Example: minconf=5

The minimum number of confirmations before payments are included

includeempty
boolean
Default: false
Enum: true false
Example: includeempty=?includeempty=true

Whether to include addresses that haven't received any payments

includewatchonly
boolean
Default: false
Enum: true false
Example: includewatchonly=?includewatchonly=true

Whether to include watchonly addresses

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of transactions since block (blockhash)

Get all transactions in blocks since block [blockhash], or all transactions if omitted. Admin

Authorizations:
ZelID
query Parameters
blockhash
string
Example: blockhash=000000b43fccbefdc72246275014e641d400851ab88f1b3f8ec483a770072537

The block hash to list transactions since

targetconfirmations
integer
Example: targetconfirmations=50

The confirmations required, must be 1 or more

includewatchonly
boolean
Default: false
Enum: true false
Example: includewatchonly=?includewatchonly=true

Whether to include watchonly addresses

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

List of recent transactions

Returns up to count most recent transactions skipping the first from transactions for account 'account'. Admin

Authorizations:
ZelID
query Parameters
count
integer
Default: 10
Example: count=25

The number of transactions to return

from
integer
Default: 0
Example: from=5

The number of transactions to skip

includewatchonly
boolean
Default: false
Enum: true false
Example: includewatchonly=?includewatchonly=true

Whether to include watchonly addresses

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns objects of unspent transactions

Returns array of unspent transaction outputs with between minconf and maxconf (inclusive) confirmations. Optionally filter to only include txouts paid to specified addresses. Results are an array of Objects, each of which has: (txid, vout, scriptPubKey, amount, confirmations). Admin

Authorizations:
ZelID
query Parameters
minconf
integer
Default: 1
Example: minconf=5

The minimum confirmations to filter

maxconf
integer
Default: 9999999
Example: maxconf=100000

The maximum confirmations to filter

addresses
Array of strings

A json array of Flux addresses to filter.

Examples:

  • addresses=["taadr", "taddr"]
  • addresses=<taadr>&addresses=<addr>

If filtering a single address url encode the array or try

  • address=["taadr"]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updates list of temporarily unspendable outputs

Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection, when spending Flux. Locks are stored in memory only. Nodes start with zero locked outputs, and the locked output list is always cleared (by virtue of process exit) when a node stops or fails. Admin

Authorizations:
ZelID
query Parameters
unlock
required
boolean
Enum: true false
Example: unlock=?unlock=false

Whether to unlock (true) or lock (false) the specified transactions

required
Array of objects

Each transaction the txid and vout key/value pair is both required.

  • txid:<transaction id>
  • vout:<output index>

Url encoded example:

  • unlock=<true/false>&transactions=%5B%7B%22txid%22%3A%2215430c14500cd505798902e2f1ce3c19251f3599954e7dfb57c19f8763530860%22%2C%22vout%22%3A0%7D%5D

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Rescans blockchain for transactions

Rescans the blockchain looking for transactions that belong to this wallet. Admin

Authorizations:
ZelID
query Parameters
startheight
integer
Default: 0
Example: startheight=545000

Block height to start rescan from

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Rescan Completed"
}

Send to many receivers at once

Send to many receivers. Amounts are decimal numbers with at most 8 digits of precision. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
amounts
object

A json object with addresses and amounts. The Flux address is the key, the numeric amount in FLUX is the value.

minconf
integer
Default: 1

Only use the balance confirmed at least this many times (optional)

comment
string

A comment used to store what the transaction is for. This is not part of the transaction, just kept in your wallet. (optional)

substractfeefromamount
Array of strings

Responses

Request samples

Content type
text/plain
{
  "amounts": {
    "t1b4SUue7q26dADLGUyFBu57uJsKS7jc8VC": 0.0001,
    "t1TtEnZKBziV5LziBXr9KvrYC2HbQA91rSN": 0.0001
  },
  "minconf": 2,
  "comment": "test api",
  "substractfeefromamount": [
    "t1b4SUue7q26dADLGUyFBu57uJsKS7jc8VC"
  ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "fe196c167d679737c716f06b66ca7249be0476b7a086c7736a38f050eab62169"
}

Send to many receivers at once

Send to many receivers. Amounts are decimal numbers with at most 8 digits of precision. Admin

Authorizations:
ZelID
query Parameters
required
object
Example: t1QSE45jkZ9docBDFh4yEV91fgZgESp5hZN=0.001&t1Nmbgvqg9zqmuW8VTXrfWzL2aTnuWARX91=0.001&t1LoTuyuH9smQ2NrYDFfn4kLfiuhKnAEELv=0.001

A json object with addresses and amounts. The Flux address is the key, the numeric amount in FLUX is the value.

minconf
number
Default: 1
Example: minconf=3

Only use the balance confirmed at least this many times

comment
string
Example: comment=Pay Flux Foundation

A comment used to store what the transaction is for. This is not part of the transaction, just kept in your wallet.

substractfeefromamount
Array of strings

Subtract the transaction fee equally from the output amounts.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "a7a6d8c1c4e155cf94af58ea1e4a8e3ddd7cc4cb1bc4d86242c1118bdf9469f2"
}

Send Flux to an address

Send an amount to a given address. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
fluxaddress
string

The flux address to send to

amount
number

The amount in FLUX to send

comment
string

A comment used to store what the transaction is for. This is not part of the transaction, just kept in your wallet. (optional)

commentto
string

comment to store the name of the person or organization to which you're sending the transaction. This is not part of the transaction, just kept in your wallet. (optional)

substractfeefromamount
boolean
Default: false

Subtract the transaction fee equally from the output amounts. (optional)

Responses

Request samples

Content type
text/plain
{
  "fluxaddress": "t1QSE45jkZ9docBDFh4yEV91fgZgESp5hZN",
  "amount": 0.001,
  "comment": "Test api",
  "commentto": "self",
  "substractfeefromamount": false
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "bbb0f5de68db9c661e11ec38c6e0cc99a1e1d202b64dc69d5a58d665dc4b5b19"
}

Send Flux to an address

Send an amount to a given address. Admin

Authorizations:
ZelID
query Parameters
fluxaddress
required
string
Example: fluxaddress=t1QSE45jkZ9docBDFh4yEV91fgZgESp5hZN

The flux address to send to

amount
required
number
Example: amount=0.001

The amount in FLUX to send

comment
string
Example: comment=Test api

A comment used to store what the transaction is for. This is not part of the transaction, just kept in your wallet.

commentto
string
Example: commentto=Self

A comment to store the name of the person or organization to which you're sending the transaction. This is not part of the transaction, just kept in your wallet.

substractfeefromamount
boolean
Default: false
Enum: true false

The fee will be deducted from the amount being sent if set to true and the recipient will receive less Flux than you enter in the amount field.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "bbb0f5de68db9c661e11ec38c6e0cc99a1e1d202b64dc69d5a58d665dc4b5b19"
}

Set transaction fee

This will restart the Flux daemon. Admin

Authorizations:
ZelID
query Parameters
amount
required
number
Example: amount=0.00001

The transaction fee in FLUX/kB rounded to the nearest 0.00000001

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Sign a message

Sign a message with the private key of a t-addr. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
taddr
string

The transparent address to use for the private key

message
string

The message to create a signature of

Responses

Request samples

Content type
text/plain
{
  "taddr": "t1N6mLX2A64QsyuLbYkfPZSrkLF86hxuuFe",
  "message": "helloworld"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "H5j8AoJ+8VaEEJGgw846hSPQoq42X9yiLwn/Nab1pASBFcw8rj5k8J9xpKr1VzepMEOF2ProYxVsQ9i7xalH4Sk="
}

Sign a message

Sign a message with the private key of a t-addr. Admin

Authorizations:
ZelID
query Parameters
taddr
required
string
Example: taddr=t1N6mLX2A64QsyuLbYkfPZSrkLF86hxuuFe

The transparent address to use for the private key

message
required
string
Example: message=helloworld

The message to create a signature of

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "H5j8AoJ+8VaEEJGgw846hSPQoq42X9yiLwn/Nab1pASBFcw8rj5k8J9xpKr1VzepMEOF2ProYxVsQ9i7xalH4Sk="
}

Reveal z-addr private key

Reveals the zkey corresponding to zaddr. Admin

Authorizations:
ZelID
query Parameters
zaddr
required
string
Example: zaddr=za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd

The zaddr for the private key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "secret-extended-key-main1qdg0nnspqqqqpqxh3quajk7fux5njuukqs3caqrhcx6cvm0f47ftlktlkm76a0pxfara7jntype360dacdzftzm8vjpqn6ytsduud40r63t3nnal0n8qp687hcje7rmp334v8zlua38f7r8emrtl2x5zjmeh97rky0j6tugr0m6qt8dxmduyawfcgjyt3v5x84753ywffwnjtsf58kfnjhdfrx3k9wgnjm7vgv7d20826s5lapfaljhpeufvsl98zf50het6a3wyj7c0xm9p7"
}

Reveal z-addr viewing key

Reveals the viewing key corresponding to zaddr. Only works with sprout zaddr's. Admin

Authorizations:
ZelID
query Parameters
zaddr
required
string
Example: zaddr=zcQNG88SQVQTuqGKdeDDhVRCXkHeR3Vv5BqeBBaYziyN48FpJM2buK1YmQtpKoVkwrM2vvhCdrVofkdLc8QYeSLyiAkQB1u

The zaddr for the private key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "ZiVKeT3VBMzNRzA6hzaYzd3d7ebcsaR9iRkhYC8nRwrVYnMZGwPCz62UJMHZnjbPURAaKqDhazDWHies6HMcHmazQUUd4R3TH"
}

Returns the balance of a taddr or zaddr

Returns the balance of a taddr or zaddr belonging to the node's wallet. CAUTION If the wallet has only an incoming viewing key for this address, then spends cannot be detected, and so the returned balance may be larger than the actual balance. Admin

Authorizations:
ZelID
query Parameters
address
required
string
Example: address=zcQNG88SQVQTuqGKdeDDhVRCXkHeR3Vv5BqeBBaYziyN48FpJM2buK1YmQtpKoVkwrM2vvhCdrVofkdLc8QYeSLyiAkQB1u

Flux address

minconf
integer
Default: 1
Example: minconf=5

Only include transactions confirmed at least this many times

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0
}

Returns status info of the sprout to sapling migration

Returns information about the status of the Sprout to Sapling migration. Note that a transaction is defined as finalized if it has at least ten confirmations. Also, it is possible that manually created transactions involving this wallet will be included in the result. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create new shielded address

Returns a new shielded address for receiving payments. Admin

Authorizations:
ZelID
query Parameters
type
string
Default: "sapling"
Enum: "sapling" "sprout"

The type of z-address.

Example:

  • type=sapling

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd"
}

Get operation result

Retrieve the result and status of an operation which has finished, and then remove the operation from memory. Admin

Authorizations:
ZelID
query Parameters
operationid
Array of strings

List of operation ids. If not provided, examine all operations known to the node.

Example:

  • operationid=["opid-6869eaa7-722f-4991-9a6e-fd6b4c388755"]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get operation status

Get operation status and any associated result or error data. The operation will remain in memory. Admin

Authorizations:
ZelID
query Parameters
operationid
Array of strings

List of operation ids. If not provided, examine all operations known to the node.

Example:

  • operationid=["opid-bdf41571-3a20-4a00-bbf2-d4e9ddbb3375"]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get total balance of wallet

Return the total value of funds stored in the node's wallet. Admin

Authorizations:
ZelID
query Parameters
minconf
integer
Default: 1
Example: minconf=5

Only include private and transparent transactions confirmed at least this many times

includewatchonly
boolean
Default: false
Enum: true false

Also include balance in watchonly addresses

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Import zaddress private key

Adds a zkey to your wallet. Admin

Authorizations:
ZelID
query Parameters
zkey
required
string
Example: zkey=secret-extended-key-main1qdg0nnspqqqqpqxh3quajk7fux5njuukqs3caqrhcx6cvm0f47ftlktlkm76a0pxfara7jntype360dacdzftzm8vjpqn6ytsduud40r63t3nnal0n8qp687hcje7rmp334v8zlua38f7r8emrtl2x5zjmeh97rky0j6tugr0m6qt8dxmduyawfcgjyt3v5x84753ywffwnjtsf58kfnjhdfrx3k9wgnjm7vgv7d20826s5lapfaljhpeufvsl98zf50het6a3wyj7c0xm9p7

The zkey

rescan
string
Default: "whenkeyisnew"
Enum: "whenkeyisnew" "yes" "no"

Rescan the wallet for transactions. Example:

  • zkey=<z private key>&rescan=yes
startheight
integer
Default: 0
Example: startheight=500000

Block height to start rescan from

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Import zaddress viewing key

Adds a viewing key to your wallet. Admin

Authorizations:
ZelID
query Parameters
vkey
required
string
Example: vkey=ZiVKeT3VBMzNRzA6hzaYzd3d7ebcsaR9iRkhYC8nRwrVYnMZGwPCz62UJMHZnjbPURAaKqDhazDWHies6HMcHmazQUUd4R3TH

The viewing key

rescan
string
Default: "whenkeyisnew"
Enum: "whenkeyisnew" "yes" "no"

Rescan the wallet for transactions. E.g. ?vkey=...&rescan=yes

startheight
integer
Default: 0
Example: startheight=500000

Block height to start rescan from

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Import wallet from export file

Imports taddr and zaddr keys from a wallet export file. Admin

Authorizations:
ZelID
query Parameters
filename
required
string
Example: filename=/path/to/file

The wallet file

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Get list of all shielded addresses

Returns the list of Sprout and Sapling shielded addresses belonging to the wallet. Admin

Authorizations:
ZelID
query Parameters
includewatchonly
boolean
Default: false
Enum: true false
Example: includewatchonly=?includewatchonly=true

Also include watchonly addresses

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get list of operation ids

Returns the list of operation ids currently known to the wallet. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of amounts received by zaddr

Return a list of amounts received by a zaddr belonging to the node's wallet. Admin

Authorizations:
ZelID
query Parameters
address
required
string
Example: address=za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd

The shielded address

minconf
integer
Default: 1
Example: minconf=5

Only include transactions confirmed at least this many times

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of unspent shielded notes

Returns array of unspent shielded notes with between minconf and maxconf (inclusive) confirmations. Admin

Authorizations:
ZelID
query Parameters
minconf
integer
Default: 1
Example: minconf=5

The minimum confirmations to filter

maxconf
integer
Default: 9999999
Example: maxconf=100000

The maximum confirmations to filter

includewatchonly
boolean
Default: false
Enum: true false
Example: includewatchonly=?includewatchonly=true

Also include watchonly addresses

addresses
Array of strings

Array of zaddrs (both Sprout and Sapling) to filter on. Duplicate addresses not allowed.

Example:

  • addresses=["za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd","zcQNG88SQVQTuqGKdeDDhVRCXkHeR3Vv5BqeBBaYziyN48FpJM2buK1YmQtpKoVkwrM2vvhCdrVofkdLc8QYeSLyiAkQB1u"]

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Send multiple transactions

Send multiple times. Amounts are decimal numbers with at most 8 digits of precision. Change generated from a taddr flows to a new taddr address, while change generated from a zaddr returns to itself. When sending coinbase UTXOs to a zaddr, change is not allowed. The entire value of the UTXO(s) must be consumed. Before Acadia (Sapling) activates, the maximum number of zaddr outputs is 54 due to transaction size limits. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
fromaddress
string

The taddr or zaddr to send the funds from

Array of objects

An array of json objects representing the amounts to send

minconf
integer
Default: 1

Only use funds confirmed at least this many times (optional)

fee
number
Default: 0.0001

The fee amount to attach to this transaction (optional)

Responses

Request samples

Content type
text/plain
{
  "fromaddress": "t1YvykLWgwT5yjVjt3GH9YEyaTdMgPsainF",
  "amounts": [
    {
      "address": "za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd",
      "amount": 0.0001,
      "memo": 5465737420617069
    }
  ],
  "minconf": 2,
  "fee": 0.00001
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "opid-e3f36550-d5cc-419d-b39c-5e822ed1e3b8"
}

Send multiple transactions

Send multiple times. Amounts are decimal numbers with at most 8 digits of precision. Change generated from a taddr flows to a new taddr address, while change generated from a zaddr returns to itself. When sending coinbase UTXOs to a zaddr, change is not allowed. The entire value of the UTXO(s) must be consumed. Before Acadia (Sapling) activates, the maximum number of zaddr outputs is 54 due to transaction size limits. Admin

Authorizations:
ZelID
query Parameters
fromaddress
required
string
Example: fromaddress=t1YvykLWgwT5yjVjt3GH9YEyaTdMgPsainF

The taddr or zaddr to send the funds from

required
Array of objects
Example: amounts=?fromaddress=...&amounts=%5B%7B%22address%22%3A%22za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd%22%2C%22amount%22%3A0.001%7D%5D

An array of json objects representing the amounts to send.

Key/value pairs in order:

  • address: <receiving address>
  • amount: <flux amount>

Url encoded example:

  • amounts=%5B%7B%22address%22%3A%22za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd%22%2C%22amount%22%3A0.001%7D%5D
minconf
integer
Default: 1
Example: minconf=?fromaddress=...&amounts=...&minconf=5

Only use funds confirmed at least this many times

fee
number
Default: 0.0001
Example: fee=?fromaddress=...&amounts=...&fee=0.000005

The fee amount to attach to this transaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "opid-6869eaa7-722f-4991-9a6e-fd6b4c388755"
}

Migrate funds to a sapling adress

When enabled the Sprout to Sapling migration will attempt to migrate all funds from this wallet’s sprout addresses to either the address for sapling account 0 or the address specified by the parameter '-migrationdestaddress'. This migration is designed to minimize information leakage. As a result for wallets with a significant sprout balance, this process may take several weeks. The migration works by sending, up to 5, as many transactions as possible whenever the blockchain reaches a height equal to 499 modulo 500. The transaction amounts are picked according to the random distribution specified in ZIP 308. The migration will end once the wallet’s sprout balance is below 0.01 FLUX. Admin

Authorizations:
ZelID
query Parameters
enabled
required
boolean
Enum: true false

True or false to enable or disable respectively

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Shield coinbase

Shield transparent coinbase funds by sending to a shielded zaddr. This is an asynchronous operation and utxos selected for shielding will be locked. If there is an error, they are unlocked. The RPC call listlockunspent can be used to return a list of locked utxos. The number of coinbase utxos selected for shielding can be limited by the caller. If the limit parameter is set to zero, and Overwinter is not yet active, the -mempooltxinputlimit option will determine the number of uxtos. Any limit is constrained by the consensus rule defining a maximum transaction size of 100000 bytes before Acadia (Sapling,) and 2000000 bytes once Acadia (Sapling) activates.. Admin

Authorizations:
ZelID
query Parameters
fromaddress
required
string
Example: fromaddress="*"

The address is a taddr or "*" for all taddrs belonging to the wallet

toaddress
required
string
Example: toaddress=za1kqwgkln5azfnnzfps0vc44ucwynstxk9k79z6nunwq0pnh4rjuww5kgy02c9wvfmdkxkxndlvdd

Zaddr to shield funds to

fee
number
Default: 0.0001

The fee amount to attach to this transaction

limit
integer
Default: 50

Limit on the maximum number of utxos to shield. Set to 0 to use node option -mempooltxinputlimit (before Overwinter), or as many as will fit in the transaction (after Overwinter).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Start Flux daemon

Tries to start Flux daemon running on the FluxNode the call is run against without any extra parameters. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Restart Flux daemon

Tries to restart Flux daemon running on the FluxNode the call is run against. Flux daemon is firstly stopped and then started without any extra parameters. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Ping request to measure ping time

Requests that a ping be sent to all other nodes, to measure ping time. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": null
}

Run benchmark of selected type and samplecount times

Runs a benchmark of the selected type and samplecount times, returning the running times of each sample. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
benchmarktype
required
string
Enum: "sleep" "parameterloading" "createjoinsplit" "verifyjoinsplit" "solveequihash" "verifyequihash" "validatelargetx" "trydecryptnotes" "trydecryptsaplingnotes" "incnotewitnesses" "incsaplingnotewitnesses" "connectblockslow" "sendtoaddress" "loadwallet" "listunspent" "createsaplingspend" "createsaplingoutput" "verifysaplingspend" "verifysaplingoutput"
Example: benchmarktype=?benchmarktype=sleep

Type of benchmark. Listed is just some of the benchmark types.

samplecount
required
integer
Example: samplecount=2

Number of samples

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Start Benchmark daemon

Start Benchmark daemon. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Starting process"
}

Stop Benchmark daemon

Stop Benchmark daemon. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Stopping process"
}

Benchmark

Calls that interact with locally running Benchmark daemon

Fluxbench status

This will return the status of the node, what FluxBenchd determined the tier the server could pass for, and if Flux backend is connected. If any one of these return a negative result the FluxNode will fail to confirm. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Fluxbench calls

This will return with a list of calls for FluxBench. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "== Benchmarks ==\ngetstatus (full_check)\nrestartnodebenchmarks\nsignfluxnodetransaction \"hexstring\"\nstartmultiportbench\n\n== Control ==\nhelp ( \"command\" )\nstop\n\n== Fluxnode ==\ngetbenchmarks\ngetinfo"
}

Benchmark results

Return most recent benchmark results. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Fluxbench status

This will return with the fluxbench status of the fluxnode. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Restart FluxBench daemon

This will restart the FluxBench daemon and start bench process. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Benchmarks will restart in the next couple minutes"
}

Stop fluxbench daemon

This will stop the fluxbench daemon. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Fluxbench server stopping"
}

Sign FluxNode transaction

Command to get FluxBenchd to sign a FluxNode broadcast. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
hexstring
string

The hex encoded FluxNode broadcast message

Responses

Request samples

Content type
text/plain
{
  "hexstring": "0500000004566e906c6df24b00ca710cecbbea166a29b9098456bed212207fea66f433ba4500000000ba33bd5e01182ebd5e010f3131362e3230332e3233372e323530411b27b3e254a9f3248d88039a0f062e0d634e130bd34a9e4a1cb27d7aa6ce975cee251be9af6864a1a4a9e9d5fc2b28a07af8bab36a73f912c59ef844a69fa03f5f411c7f47ba609b2c0eb91268b446b31899ce66f90fa1375aab29692f1b252a53a9883120e10c646292486365608dc806c43e2d49b66afdd150a6a7f60b6b2392a83b"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Sign FluxNode transaction

Command to get FluxBenchd to sign a FluxNode broadcast. Admin

Authorizations:
ZelID
query Parameters
hexstring
required
string
Example: hexstring=0500000004566e906c6df24b00ca710cecbbea166a29b9098456bed212207fea66f433ba4500000000ba33bd5e01182ebd5e010f3131362e3230332e3233372e323530411b27b3e254a9f3248d88039a0f062e0d634e130bd34a9e4a1cb27d7aa6ce975cee251be9af6864a1a4a9e9d5fc2b28a07af8bab36a73f912c59ef844a69fa03f5f411c7f47ba609b2c0eb91268b446b31899ce66f90fa1375aab29692f1b252a53a9883120e10c646292486365608dc806c43e2d49b66afdd150a6a7f60b6b2392a83b

The hex encoded fluxnode broadcast message

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Flux

Calls that interact with Flux and its network

Starts Flux daemon

Tries to start Flux daemon running on the Flux node the call is run against without any extra parameters. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Restarts Flux daemon

Tries to restart Flux daemon running on the Flux node the call is run against. Flux daemon is firstly stopped and then started without any extra parameters. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Switch to master branch of FluxOS

Tries to switch to master branch of FluxOS. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Switch to development branch of FluxOS

Tries to switch to development branch of FluxOS. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Reindexes Flux daemon

Tries to reindex Flux daemon running on the Flux node the call is run against. Flux daemon is firstly stopped and then started with reindex flag. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updates Flux to the latest version

Updates Flux to the latest version available according to github master branch. Flux will restart its services after the update. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Perform hard update to the latest version

Hard updates to latest version by removing node_modules and package-lock.json before executing git reset --hard and git pull. This may resolve any issues that may arise from Flux not being able to update using the GET /flux/updateflux call. Flux will restart its services after the update. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Rebuild UI - Home of Flux

Rebuilds Home part of Flux. May help resolving frontend issues. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updates Flux daemon

Updates the Flux daemon of Flux node to the latest available version according to official Flux APT repository. Flux daemon is restarted with no extra parameters during this update. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updates Benchmark daemon

Updates the Benchmark daemon of Flux node to the latest available version according to official Flux APT repository. Benchmark daemon is restarted with no extra parameters during this update. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns with the Flux debug log

Returns with the debug log located in Flux data directory. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2020-05-09 11:27:30 Flux version v4.0.1-32bd16d-dirty (2020-03-20 19:05:39 +0000) 2020-05-09 11:27:30 AppInit2: parameter interaction: -externalip set -> setting -discover=0 2020-05-09 11:27:30 Using BerkeleyDB version Berkeley DB 6.2.23: (March 28, 2016) 2020-05-09 11:27:30 Default data directory /home/user/.flux 2020-05-09 11:27:30 Using data directory /home/user/.flux/ 2020-05-09 11:27:30 Using config file /home/user/.flux/flux.conf 2020-05-09 11:27:30 Using at most 256 connections (1024 file descriptors available) 2020-05-09 11:27:30 Using 2 threads for script verification 2020-05-09 11:27:30 scheduler thread start 2020-05-09 11:27:30 Loading Sapling (Spend) parameters from /home/user/.zcash-params/sapling-spend.params 2020-05-09 11:27:30 Loading Sapling (Output) parameters from /home/user/.zcash-params/sapling-output.params 2020-05-09 11:27:30 Loading Sapling (Sprout Groth16) parameters from /home/user/.zcash-params/sprout-groth16.params 2020-05-09 11:27:34 Loaded Sapling parameters in 4.129045s seconds. 2020-05-09 11:27:34 Binding RPC on address 0.0.0.0 port 16124 failed. 2020-05-09 11:27:34 HTTP: creating work queue of depth 16 2020-05-09 11:27:34 HTTP: starting 4 worker threads 2020-05-09 11:27:34 Using wallet wallet.dat 2020-05-09 11:27:34 init message: Verifying wallet..."

Returns with the Benchmark debug log

Returns with the debug log located in fluxbenchmark directory. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2020-05-13 16:59:02 Benchmark version v1.0.0-beta1-53e0ea2-dirty (2020-04-25 13:03:38 +0800) 2020-05-13 16:59:02 Using OpenSSL version OpenSSL 1.1.1a 20 Nov 2018 2020-05-13 16:59:02 HTTP: creating work queue of depth 16 2020-05-13 16:59:02 HTTP: starting 4 worker threads 2020-05-13 16:59:02 Bound to [::]:16225 2020-05-13 16:59:02 Bound to 0.0.0.0:16225 2020-05-13 16:59:02 init message: Done loading 2020-05-13 16:59:02 Starting Fluxnodes Benchmarking Thread 2020-05-13 16:59:03 Path: /home/user/flux/ZelBack 2020-05-13 16:59:03 ---Flux usage: 0.23012 2020-05-13 16:59:03 ---package evaluator system setup starting 2020-05-13 16:59:03 ---package evaluator already installed 2020-05-13 16:59:03 ---package evaluator found version: 1.0.11 2020-05-13 16:59:03 ---package evaluator system setup completed 2020-05-13 16:59:03 ---Starting computer specs test 2020-05-13 16:59:08 ---Found cores: 2 2020-05-13 16:59:08 ---Found ram: 3.8 2020-05-13 16:59:08 ---Found HDD: 38.200001 G 2020-05-13 16:59:08 ---Found HDD: 12.000000 G 2020-05-13 16:59:08 ---Found DD_WRITE: 675.628 2020-05-13 16:59:08 ---Finished computer specs test 2020-05-13 16:59:08 ---Starting package evaluator test 2020-05-13 16:59:29 ---Found eps v1: 157.185 2020-05-13 16:59:29 ---Finished package evaluator test"

Returns last lines of Flux debug log

Returns last 100 lines known in the Flux debug log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns last lines of Benchmark debug log

Returns last 100 lines known in the Benchmark debug log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns with the Flux error log

Returns with the error log located in flux directory. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2020-05-13T11:43:35.223Z {} 2020-05-13T16:58:20.492Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-13T16:58:20.494Z {} 2020-05-13T16:58:29.181Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-13T16:59:03.686Z {\"code\":-28,\"name\":\"Error\",\"message\":\"Loading fluxnode payment cache...\"} 2020-05-13T20:51:36.484Z {} 2020-05-14T07:15:38.355Z {} 2020-05-14T12:18:38.695Z {} 2020-05-14T13:30:35.112Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-14T13:30:35.114Z {} 2020-05-14T13:30:38.782Z {} 2020-05-14T13:31:09.309Z {\"code\":-28,\"name\":\"Error\",\"message\":\"Loading fluxnode payment cache...\"} 2020-05-14T13:37:30.205Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-14T13:38:10.519Z {\"code\":-28,\"name\":\"Error\",\"message\":\"Loading fluxnode payment cache...\"} 2020-05-14T13:58:08.810Z {} 2020-05-14T14:49:30.295Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-14T14:49:32.669Z {\"code\":\"ECONNREFUSED\",\"name\":\"Error\",\"message\":\"connect ECONNREFUSED 127.0.0.1:16124\"} 2020-05-14T14:49:32.672Z {} 2020-05-14T14:50:10.807Z {\"code\":-28,\"name\":\"Error\",\"message\":\"Loading fluxnode payment cache...\"} 2020-05-14T16:19:39.197Z {}"

Returns last lines of Flux error log

Returns last 100 lines known in the Flux error log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Node Tier

This call will display the tier of the node. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "cumulus"
}

Combined info

Combined info of statuses. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Flux timezone

This will return with the timezone of the server. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Europe/Berlin"
}

Gets version of Flux

Gets version of Flux running on the Flux node the call is run against as it is in package.json. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "4.1.0"
}

Flux IP

This will return with the IP address of the server that Flux is on. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "49.12.8.215"
}

Flux static IP status

This will return true if FluxNode is running under a known static ip ISP/Org. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Geolocation info

This will return geolocation info. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Admin's ZelID

This will return with the admin's ZelID. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1CcoEkKQZcwUXPSps4bZJDjUM3mqe9bNXf"
}

PGP identity

This will return node pgp public key. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nxjMEZOMsEBYJKwYBBAHaRw8BAQdAqjIh7dGGpEwo2bHAJKPnZJLclDSKPysv\ngmK3Va+8fcPNdDFlN2U1ODU0YjdlMjk4OWU5NTNlMTA1MGY0MGFmY2YzYWUz\nZDQ3ZThlNWI1NDgyZWYyZWViNWZkNTY2ZmNmMmE6MCA8MUhXalE5UzNNeXpW\nNkVidERNRWtwSG0zMXBhcnlhNDEyTkBydW5vbmZsdXguaW8+wowEEBYKAD4F\ngmTjLBAECwkHCAmQSQ3C8FnVJhkDFQgKBBYAAgECGQECmwMCHgEWIQQAyk4E\nGn08EnjEMCtJDcLwWdUmGQAAC2QBANAEdUdQEUTLQNYnGRzrCvqzBqdPGbJT\n/zW0nyF8ZLJgAP9pS8OLA3eoYzkhoJKuOn4qcUr48PcBcGzEIpgZFKPPBM44\nBGTjLBASCisGAQQBl1UBBQEBB0AoXsfprvNft3PNBsCPz9VMl8e342PDq91X\nVJeSeBnCSAMBCAfCeAQYFggAKgWCZOMsEAmQSQ3C8FnVJhkCmwwWIQQAyk4E\nGn08EnjEMCtJDcLwWdUmGQAATboA/3hxWLcTxPRQokx+BlcIXHuRu3fK9cnj\nUW6j9M99t6hTAQDDdiNNDAEIOnWXBr1NZiD3iqhPv5zOkLDRtpyw+7NGCw==\n=crwl\n-----END PGP PUBLIC KEY BLOCK-----\n"
}

Kadena Info

This call will display the user's Kadena address and chain ID. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "kadena:k:7a1529b3a07fate32d75684ab20bdde61545d60f1c6bcbf2489fef857a316652?chainid=0"
}

Admin's CruxID

This will return with the admin's CruxID. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "dk808@zel.crux"
}

DOS state

This will return with the DOS state that Flux is in from 0 to infinity and if it reaches 10 it gets banned. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Gets IP's of connected peers

Gets list of IP addresses of outgoing connected peers. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Gets info of connected peers

Gets list of ip addresses and rtt of the outgoing connected peers. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of incoming connections

Gets list of IP addresses of incoming connected peers. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Gets info of incoming connections

Gets list of ip addresses and rtt of incoming connections. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Check availability of Flux

Check if Flux is reachable and available using IP of the Flux's server. Public

query Parameters
ip
required
string
Example: ip=193.188.15.245

Ip address

Responses

Response samples

Content type
application/json
{
  • "status": "sucess",
  • "data": {
    }
}

Check incoming/outgoing peers

Check if there is enough incoming/outgoing peers. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxOS uptime

Return FluxOS uptime in seconds. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 467
}

Broadcast message to peers

Broadcast data message to peers that are connected. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: text/plain
required
data
string

The message

Responses

Request samples

Content type
text/plain
{
  "data": "a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Broadcast message to peers

Broadcast data message to peers that are connected. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
data
required
string
Example: data=a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23

The message

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Broadcast message to outgoing peers

Broadcast data message to peers on outgoing connections. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: text/plain
required
data
string

The message

Responses

Request samples

Content type
text/plain
{
  "data": "a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Broadcast message to outgoing peers

Broadcast data message to peers on outgoing connections. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
data
required
string
Example: data=a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23

The message

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Broadcast message to incoming peers

Broadcast data message to peers on incoming connections. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: text/plain
required
data
string

The message

Responses

Request samples

Content type
text/plain
{
  "data": "a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Broadcast message to incoming peers

Broadcast data message to peers on incoming connections. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
data
required
string
Example: data=a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23

The message

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Add peer option

This call gives option to add peers to outgoing connections. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
ip
required
string
Example: ip=49.12.8.215

Ip of peer to add

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Remove peer option

This call does exact opposite of add and removes/drops a outgoing connected peer. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
ip
required
string
Example: ip=49.12.8.215

Ip of peer to remove

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Remove incoming peer

Remove a incoming connected peer. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
ip
required
string
Example: ip=49.12.8.215

Ip of peer to remove

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Open port on server

This will open a port on the server and adding it to the firewall rules. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
port
required
integer
Example: port=22222

Port number to open

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Adjust CruxID

This will add/update your CruxID. Admin

Authorizations:
ZelID
query Parameters
cruxid
required
string
Example: cruxid=dk808@zel.crux

CruxID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Adjust Kadena Account

Essentially rebuilds flux - use with caution! Admin

Authorizations:
ZelID
query Parameters
account
required
string
Example: account=k:7a1529b3a07fate32d75684ab20bdde61545d60f1c6bcbf2489fef857a316652

Kadena Account

chainid
required
string

Kadena ChainID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Start Benchmark

This call will start the benchmark which tests the hardware specifications and performance. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Restart Benchmark

This call will restart the benchmark which tests the hardware specifications and performance. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Soft Update Flux

This call will perform a soft update of Flux. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Install Flux

This call will install Flux. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Warning Log

This call returns the Flux warning log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2022-01-23T15:23:33.638Z Daemon not yet synced. Flux discovery is awaiting. 2022-01-23T15:25:33.655Z Node not confirmed. Flux discovery is awaiting. 2022-01-23T15:27:33.869Z Unexpected token B in JSON at position 0 2022-01-23T15:29:34.535Z Flux IP not detected. Flux discovery is awaiting."

Debug Log

This call returns the Flux debug log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2022-01-23T15:23:33.049Z Flux running on port 16127! 2022-01-23T15:23:33.051Z Initiating MongoDB connection 2022-01-23T15:23:33.075Z Flux Home running on port 16126! 2022-01-23T15:23:33.106Z DB connected 2022-01-23T15:23:33.106Z Preparing local database... 2022-01-23T15:23:33.471Z Local database prepared 2022-01-23T15:23:33.472Z Preparing temporary database... 2022-01-23T15:23:33.505Z Temporary database prepared 2022-01-23T15:23:33.505Z Preparing Flux Apps locations 2022-01-23T15:23:33.554Z Flux Apps locations prepared 2022-01-23T15:23:33.571Z Firewalls checked 2022-01-23T15:23:33.572Z Connections polling prepared 2022-01-23T15:23:33.580Z Flux Daemon Info Service Started 2022-01-23T15:23:33.619Z Flux checks operational 2022-01-23T15:23:33.638Z Daemon not yet synced. Flux discovery is awaiting. 2022-01-23T15:23:33.639Z Flux Discovery started"

Info Log

This call returns the Flux info log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
"2022-01-23T15:23:33.047Z Flux running on port 16127! 2022-01-23T15:23:33.050Z Initiating MongoDB connection 2022-01-23T15:23:33.071Z Flux Home running on port 16126! 2022-01-23T15:23:33.105Z DB connected 2022-01-23T15:23:33.106Z Preparing local database... 2022-01-23T15:23:33.431Z Local database prepared 2022-01-23T15:23:33.472Z Preparing temporary database... 2022-01-23T15:23:33.505Z Temporary database prepared 2022-01-23T15:23:33.505Z Preparing Flux Apps locations 2022-01-23T15:23:33.554Z Flux Apps locations prepared 2022-01-23T15:23:33.571Z Firewalls checked"

Tail Warn Log

This call returns the Flux tail warn log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Tail Debug Log

This call returns the Flux tail debug log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Tail Info Log

This call returns the Flux tail info log. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Local Folder Location

This call returns the local folder location for Flux. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "/home/username/flux/ZelBack/"
}

Map a specified port (UPnP)

This call map a specified port (UPnP). AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
port
required
integer
Example: port=666

Port number

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Unmap a specified port (UPnP)

This call unmap a specified port (UPnP). AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
port
required
integer
Example: port=666

Port number

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Show list with mappings (UPnP)

This call show message with mappings (UPnP). AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Show public IP address (UPnP)

This call show public IP address (UPnP). AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "84.28.5.7"
}

Show gateway address (UPnP)

This call show a message with gateway address (UPnP). AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

To show the current user's Router IP setup.

To show the current user's Router IP setup in configuration file that is being used with FluxO. PUBLIC

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "196.53.8.65"
}

Update the current routerIP.

Update the current routerIP that is being used with FluxOS. Admin

Authorizations:
ZelID
query Parameters
routerip
string
Example: routerip=196.53.8.65

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Router IP adjusted"
}

Show the current user's blocked ports list.

Show the current user's blocked ports list. PUBLIC

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Update blocked port list.

Update the current blocked port list that is being used by FluxOS. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
blockedPorts
Array of numbers

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Show the current user's blocked repositories list.

Show the current user's blocked repositories list. PUBLIC

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Update blocked repositories list.

Update the current blocked repositories list that is being used by FluxOS. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
blockedRepositories
Array of strings

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Show the current user's Api Port setup in configuration file that is being used by FluxOS.

Show the current user's Api Port. PUBLIC

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 16127
}

Update Api Port setup in configuration file that is being used by FluxOS.

Update Api Port. PUBLIC

Authorizations:
ZelID
query Parameters
apiport
number
Example: apiport=16127

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "API Port adjusted"
}

Show marketplace URL.

Show marketplace URL based on current development flag setup in configuration file that is being used with FluxOS. PUBLIC

Responses

Response samples

Content type
application/json
{}

Restart FluxOS.

Restart FluxOS. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Restarting FluxOS.."
}

Show system uptime.

Show system uptime in ms. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 2531565
}

Show nodejs entire versions object.

Show nodejs entire versions object. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get all Flux IDs

Get list of all Flux IDs associated with this node. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Check if running on ArcaneOS

Check if the node is running on ArcaneOS (specialized Flux operating system). Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": true
}

Stream chain preparation

Prepare for blockchain streaming operation. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Stream blockchain data

Stream blockchain data to another node. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: application/json
required
targetNode
required
string

Target node IP address

startHeight
integer

Starting block height

endHeight
integer

Ending block height

Responses

Request samples

Content type
application/json
{
  • "targetNode": "string",
  • "startHeight": 0,
  • "endHeight": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Check application availability

Check if a specific application is available and accessible. Public

Request Body schema: application/json
required
appname
required
string

Name of the application to check

ip
string

IP address to check availability from

port
integer

Port to check

Responses

Request samples

Content type
application/json
{
  • "appname": "string",
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Keep UPnP ports open

Maintain UPnP port mappings to keep them open. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: application/json
required
ports
required
Array of integers

List of ports to keep open

Responses

Request samples

Content type
application/json
{
  • "ports": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Apps

Calls that interact with Apps fascilitated by local Flux and Flux network

list running apps

List and info of running apps. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

list all apps

List and info of all apps. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of images

List of apps images installed. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

installed apps

Info of installed apps. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

available apps

Info of available apps. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Flux's usage

Will return amount of cpu resource flux is using. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 0.20717773
}

Flux's usage of resources

Will return data of resource flux is using. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Registration Info

Apps registration info. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Temporary registration info

Temporary registration info that will expire after 1 hour. Public

query Parameters
hash
string
Example: hash=e9293e7eebc51586e7b90557f924b70a766ab970c91a6c923520577021424cb9

Aplication hash

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Permanent registration info

Registration info of apps that have been stored to the database. Public

query Parameters
hash
string
Example: hash=e9293e7eebc51586e7b90557f924b70a766ab970c91a6c923520577021424cb9

Application hash

owner
string
Example: owner=15Mt8ctAFTVVzsx9UynnqxgM5JJuiwMPhs

Application ZelID

appname
string
Example: appname=FoldingAtFluxCloud1693167320638

Application name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Global app specs

List of global app specifications. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Global app specs of app specified

This will return app specifications of the queried app. Public

query Parameters
appname
required
string
Example: appname=mexcdnxbot

Appname

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

App owner's ZelID

This will return the ZelID of the owner of the app specified. Public

query Parameters
appname
required
string
Example: appname=CryptPadOnFlux

Appname

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC"
}

Application Hash info

Get list of app hashes and related info. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Info regarding app location

This will return data regarding the location of app specified. Public

query Parameters
appname
required
string
Example: appname=electrumxtest

Appname

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

List of app locations

This will return a list of known apps on the network and it's locations data. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Calculate price of app Deprecated

DEPRECATED: To get app price. Should be used getAppFiatAndFluxPrice method instead. Calculate price by sending request with specs required for app you are registering. Public Note: If tiered value is set to true you will also need to add the following key/value pairs

  • cpubasic: <n value of cpu core>, cpusuper: <n value of cpu core>, cpubamf: <n value of cpu core>, rambasic: <n value in mb>, ramsuper: <n value in mb>, rambamf: <n value in mb>, hddbasic: <n value in gb>, hddsuper: <n value in gb>, hddbamf: <n value in gb>
Request Body schema: text/plain
required
version
integer

Version of message which is 7

name
string

Name of app

description
string

Description of app

owner
string

Your ZelID

Array of objects
instances
integer

Instances number

contacts
Array of strings
geolocation
Array of strings
expire
integer

Number of blocks after apps expire

nodes
Array of strings
staticip
boolean

If set to true apps will be installed of nodes with static IP only.

Responses

Request samples

Content type
text/plain
{
  "version": 7,
  "name": "blockbookneurai",
  "description": "Blockbook for Neurai",
  "owner": "1XcNTEsgVND4eb3bsVa2bjktnZZSruVct",
  "compose": [
    {
      "name": "blockbookneurai",
      "description": "Blockbook for Neurai",
      "repotag": "runonflux/blockbook-docker:latest",
      "ports": [
        38382,
        38383
      ],
      "domains": [
        "",
        ""
      ],
      "environmentParameters": [],
      "commands": [],
      "containerPorts": [
        9199,
        1337
      ],
      "containerData": "/root",
      "cpu": 2.5,
      "ram": 5000,
      "hdd": 40,
      "tiered": false,
      "secrets": "",
      "repoauth": ""
    }
  ],
  "instances": 3,
  "contacts": [],
  "geolocation": [],
  "expire": 22000,
  "nodes": [],
  "staticip": false
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 1.6
}

Calculate price of app

Calculate price by sending request with specs required for app you are registering. Public Note: If tiered value is set to true you will also need to add the following key/value pairs

  • cpubasic: <n value of cpu core>, cpusuper: <n value of cpu core>, cpubamf: <n value of cpu core>, rambasic: <n value in mb>, ramsuper: <n value in mb>, rambamf: <n value in mb>, hddbasic: <n value in gb>, hddsuper: <n value in gb>, hddbamf: <n value in gb>
Request Body schema: text/plain
required
version
integer

Version of message which is 7

name
string

Name of app

description
string

Description of app

owner
string

Your ZelID

Array of objects
instances
integer

Instances number

contacts
Array of strings
geolocation
Array of strings
expire
integer

Number of blocks after apps expire

nodes
Array of strings
staticip
boolean

If set to true apps will be installed of nodes with static IP only.

Responses

Request samples

Content type
text/plain
{
  "version": 7,
  "name": "blockbookneurai",
  "description": "Blockbook for Neurai",
  "owner": "1XcNTEsgVND4eb3bsVa2bjktnZZSruVct",
  "compose": [
    {
      "name": "blockbookneurai",
      "description": "Blockbook for Neurai",
      "repotag": "runonflux/blockbook-docker:latest",
      "ports": [
        38382,
        38383
      ],
      "domains": [
        "",
        ""
      ],
      "environmentParameters": [],
      "commands": [],
      "containerPorts": [
        9199,
        1337
      ],
      "containerData": "/root",
      "cpu": 2.5,
      "ram": 5000,
      "hdd": 40,
      "tiered": false,
      "secrets": "",
      "repoauth": ""
    }
  ],
  "instances": 3,
  "contacts": [],
  "geolocation": [],
  "expire": 22000,
  "nodes": [],
  "staticip": false
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Starts app

This will start the fluxapp. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux App fluxFoldingAtHome successfully started."
}

Stops app

This will stop the Flux application. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux App fluxFoldingAtHome successfully stopped."
}

Restarts app

This will restart the Flux application. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux App fluxFoldingAtHome successfully restarted."
}

Pause app

This will pause the fluxapp. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux App fluxFoldingAtHome successfully paused."
}

Unpause app

This will unpause the Flux application. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux App fluxFoldingAtHome successfully unpaused."
}

List of running processes

Display the running processes of a container. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

App's log

This will fetch the logs of a fluxapp. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=fluxFoldingAtHome

Name/Id of app

required
integer or string
Example: line=30

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "21:12:16:****************************** FAHClient ******************************\n21:12:16: Version: 7.6.9\n21:12:16: Author: Joseph Coffland <joseph@cauldrondevelopment.com>\n21:12:16: Copyright: 2020 foldingathome.org\n21:12:16: Homepage: https://foldingathome.org/\n21:12:16: Date: Apr 17 2020\n21:12:16: Time: 18:11:26\n21:12:16: Revision: 398c2b17fa535e0cc6c9d10856b2154c32771646\n21:12:16: Branch: master\n21:12:16: Compiler: GNU 8.3.0\n21:12:16: Options: -std=c++11 -ffunction-sections -fdata-sections -O3 -funroll-loops\n21:12:16: -fno-pie\n21:12:16: Platform: linux2 4.19.0-5-amd64\n21:12:16: Bits: 64\n21:12:16: Mode: Release\n21:12:16: Args: --user=1CcoEkKQZcwUXPSps4bZJDjUM3mqe9bNXf --team=262156 --passkey=\n21:12:16: --gpu=false --smp=true --power=full --gui-enabled=false --allow 0/0\n21:12:16: --web-allow 0/0\n21:12:16:******************************** CBang ********************************\n21:12:16: Date: Apr 17 2020\n21:12:16: Time: 18:10:13\n21:12:16: Revision: 2fb0be7809c5e45287a122ca5fbc15b5ae859a3b\n21:12:16: Branch: master\n21:12:16: Compiler: GNU 8.3.0\n21:12:16: Options: -std=c++11 -ffunction-sections -fdata-sections -O3 -funroll-loops\n21:12:16: -fno-pie -fPIC\n21:12:16: Platform: linux2 4.19.0-5-amd64\n21:12:16: Bits: 64\n21:12:16: Mode: Release\n21:12:16:******************************* System ********************************"
}

Info of the app

Displays detailed info of the container. AppOwnerAbove

Authorizations:
ZelID
query Parameters
container
required
string
Example: container=fluxFoldingAtHome

Name/Id of app

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

App stats based on resource usage

Returns containers resource usage. AppOwnerAbove

https://docs.docker.com/engine/api/v1.40/#operation/ContainerStats
Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=fluxdibi-UND

App name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "pids_stats": { },
  • "blkio_stats": {
    },
  • "num_procs": 0,
  • "storage_stats": { },
  • "cpu_stats": {
    },
  • "precpu_stats": {
    },
  • "memory_stats": {
    },
  • "name": "/fluxdibi-UND",
  • "id": "1e2f681c8a356c0af561bcefb3a85b8dbe690487598a004fef1c4a65001e0078",
  • "networks": {
    }
}

Container changes

Data of changes made to container. If no changes it will return a null response which is usually the case. AppOwnerAbove

Kind values:

  • 0 = Modified
  • 1 = Added
  • 2 = Deleted
Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=fluxdibi-UND

App name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Run a command in the container

Run new commands inside running containers. AppOwner

Authorizations:
ZelID
Request Body schema: text/plain
required
appname
string

App name

cmd
Array of strings
env
Array of strings

Responses

Request samples

Content type
text/plain
{
  "appname": "dibi-UND",
  "cmd": [
    "date"
  ]
}

Response samples

Content type
application/json
"Sun Sep 20 10:18:38 UTC 2020"

Uninstall application

This will stop, clean data, close port, and remove the container. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=fluxFoldingAtHome

Name of the app

force
boolean
Default: false

Defaults to false. If true, forces removal without checking if the app exists.

global
boolean
Default: false

Defaults to false (local removal). If true, removes the app from all nodes in the network.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "App fluxFoldingAtHome was successfully removed"
}

Install local app

Register, install, and run app specified in query param. AdminAndFluxTeam

Note: Below example of response is last bit of a continuous stream of data

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtHomeB

App name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "App fluxFoldingAtHomeB successfully started."
}

Create flux network

This will create flux network if none is detected. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Flux Network already exists."
}

Rescan and update global FluxApps info database

Rescans global apps permanent messages since selected blockheight and updates global apps information database. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
blockheight
required
integer
Example: blockheight=680000

Block height to rescan from

removelastinformation
boolean
Default: false
Enum: true false

If set to true then before the actual rescan happens all global information specifications will be removed.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Reindex appsinformation collection and rebuild

This will drop appslocations collection, recreate indexes, and rebuild incoming messages. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Reindex appslocations collection and rebuild

Function that drops information about running apps and rebuilds indexes. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Checks Docker Hub for image

This will check Docker Hub and verify image is available. User

Authorizations:
ZelID
Request Body schema: text/plain
required
repotag
string

Repotag of docker image in this format namespace/repository:tag

Responses

Request samples

Content type
text/plain
{
  "repotag": "bharathshetty4/supermario:latest"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

App registration

This call is to provide required info to register app on Flux. User

Note: Signature is following message signed in the format shown below

  • this.updatetype + this.version + JSON.stringify(fluxAppSpecFormatted) + this.timestamp

Example:

  • fluxappregister1{"version":7,"name":"blockbookneurai","description":"Blockbook for Neurai","owner":"1XcNTEsgVND4eb3bsVa2bjktnZZSruVct","compose":[{"name":"blockbookneurai","description":"Blockbook for Neurai","repotag":"runonflux/blockbook-docker:latest","ports":[38382,38383],"domains":["",""],"environmentParameters":["COIN=neurai","BLOCKBOOK_PORT=9168","BLOCKBOOKGIT_URL=https://github.com/NeuraiProject/blockbook"],"commands":[],"containerPorts":[9168,1337],"containerData":"/root","cpu":2.5,"ram":5000,"hdd":40,"tiered":false,"secrets":"","repoauth":""}],"instances":3,"contacts":[],"geolocation":[],"expire":22000,"nodes":[],"staticip":false}1692605469050
Authorizations:
ZelID
Request Body schema: text/plain
required
type
string

Message type

version
integer

Message version

object (appspecification)
timestamp
integer

Current timestamp in epoch/unix

signature
object

Signature of data message you signed with ZelID.

Responses

Request samples

Content type
text/plain
{
  "type": "fluxappregister",
  "version": 1,
  "appSpecifications": {
    "version": 7,
    "name": "blockbookneurai",
    "description": "Blockbook for Neurai",
    "owner": "1XcNTEsgVND4eb3bsVa2bjktnZZSruVct",
    "compose": [
      {
        "name": "blockbookneurai",
        "description": "Blockbook for Neurai",
        "repotag": "runonflux/blockbook-docker:latest",
        "ports": [
          38382,
          38383
        ],
        "domains": [
          "",
          ""
        ],
        "environmentParameters": [],
        "commands": [],
        "containerPorts": [
          9199,
          1337
        ],
        "containerData": "/root",
        "cpu": 2.5,
        "ram": 5000,
        "hdd": 40,
        "tiered": false,
        "secrets": "",
        "repoauth": ""
      }
    ],
    "instances": 3,
    "contacts": [],
    "geolocation": [],
    "expire": 22000,
    "nodes": [],
    "staticip": false
  },
  "timestamp": 1692605469050,
  "signature": "II3DdnuO5j6qPVAjid4zac3QRUpvdwwSwCGYoHTQqozveFPnSAueeYW3oPN1+oN2pJSFnXgxeT/odisfGRF5uu0="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23"
}

App update

This call is to provide required info to update app on Flux. User

Note: Signature is following message signed in the format shown below

  • this.updatetype + this.version + JSON.stringify(fluxAppSpecFormatted) + this.timestamp

Example:

  • fluxappupdate1{"version":7,"name":"blockbookneurai","description":"Blockbook for Neurai","owner":"1HWjQ9S3MyzV6EbtDMEkpHm31parya412N","compose":[{"name":"blockbookneurai","description":"Blockbook for Neurai","repotag":"runonflux/blockbook-docker:latest","ports":[38382,38383],"domains":["",""],"environmentParameters":["COIN=neurai","BLOCKBOOK_PORT=9168","BLOCKBOOKGIT_URL=https://github.com/NeuraiProject/blockbook"],"commands":[],"containerPorts":[9168,1337],"containerData":"/root","cpu":2.5,"ram":5000,"hdd":40,"tiered":false,"secrets":"","repoauth":""}],"instances":3,"contacts":[],"geolocation":[],"expire":22000,"nodes":[],"staticip":false}1692697789387
Authorizations:
ZelID
Request Body schema: text/plain
required
object (appspecification)
timestamp
integer

Current timestamp in epoch/unix

signature
object

Signature of data message you signed with ZelID.

type
string

Message type

version
integer

Message version

Responses

Request samples

Content type
text/plain
{
  "type": "fluxappupdate",
  "version": 1,
  "appSpecifications": {
    "version": 7,
    "name": "blockbookneurai",
    "description": "Blockbook for Neurai",
    "owner": "1HWjQ9S3MyzV6EbtDMEkpHm31parya412N",
    "compose": [
      {
        "name": "blockbookneurai",
        "description": "Blockbook for Neurai",
        "repotag": "runonflux/blockbook-docker:latest",
        "ports": [
          38382,
          38383
        ],
        "domains": [
          "",
          ""
        ],
        "environmentParameters": [
          "COIN=neurai",
          "BLOCKBOOK_PORT=9168",
          "BLOCKBOOKGIT_URL=https://github.com/NeuraiProject/blockbook"
        ],
        "commands": [],
        "containerPorts": [
          9168,
          1337
        ],
        "containerData": "/root",
        "cpu": 2.5,
        "ram": 5000,
        "hdd": 40,
        "tiered": false,
        "secrets": "",
        "repoauth": ""
      }
    ],
    "instances": 3,
    "contacts": [],
    "geolocation": [],
    "expire": 22000,
    "nodes": [],
    "staticip": false
  },
  "timestamp": 1692697789387,
  "signature": "HxtjvY3/CSoKxlaAZ4seno5qNYSZLVQ30IEqC1pw8644YjtN0H5IC131XaPkTrptUmxTHCVxE/gIQZsld4lWX54="
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "a7a5b90b25ccc0a8379ec960c103103390369d1d6d18f88281372b944531dc23"
}

Deployment information

This will return deployment information. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

List of enterprise nodes

This will return a list of enterprise nodes. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Request application message hash.

This will request application message hash. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
hash
required
string
Example: hash=bf3d860a1d5d0379519afc7da441fb56c688f83e528162d5f6825c05f6c27e7a

Application hash

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Request check for missing application message.

This will tigger check for misssing application messages. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get latest application specification version

Get the latest version of application specifications available. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update app to latest specifications

Update application to use latest specification format. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application to update

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get application original owner

Get the original owner of a specific application. Public

path Parameters
appname
string
Example: electrumxtest

Name of the application

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "1CbErtneaX2QVyUfwU7JGB7VzvPgrgc3uC"
}

Get app installing location

Get the location where a specific app is currently being installed. Public

path Parameters
appname
string
Example: electrumxtest

Name of the application

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get all apps installing locations

Get locations where all apps are currently being installed. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get app installation errors location

Get the location where a specific app had installation errors. Public

path Parameters
appname
string
Example: electrumxtest

Name of the application

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get all apps installation errors locations

Get locations where all apps had installation errors. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Get whitelisted repositories

Get list of whitelisted Docker repositories for app deployment. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Verify app registration specifications

Verify and format application registration specifications. Public

Request Body schema: application/json
required
appname
required
string

Application name

version
integer

Application version

description
required
string

Application description

owner
required
string

Application owner ZelID

port
required
integer

Application port

containerPort
required
integer

Container port

cpu
required
number

CPU requirements

ram
required
integer

RAM requirements in MB

hdd
required
integer

Storage requirements in GB

tiered
boolean

Whether app is tiered

cpubasic
number

Basic tier CPU

rambasic
integer

Basic tier RAM

hddbasic
integer

Basic tier storage

cpusuper
number

Super tier CPU

ramsuper
integer

Super tier RAM

hddsuper
integer

Super tier storage

cpubamf
number

BAMF tier CPU

rambambf
integer

BAMF tier RAM

hddbamf
integer

BAMF tier storage

repotag
required
string

Docker repository tag

enviromentParameters
Array of arrays

Environment variables

commands
Array of arrays

Container commands

domains
Array of arrays

Custom domains

compose
Array of arrays

Docker compose configuration

Responses

Request samples

Content type
application/json
{
  • "appname": "string",
  • "version": 0,
  • "description": "string",
  • "owner": "string",
  • "port": 0,
  • "containerPort": 0,
  • "cpu": 0,
  • "ram": 0,
  • "hdd": 0,
  • "tiered": true,
  • "cpubasic": 0,
  • "rambasic": 0,
  • "hddbasic": 0,
  • "cpusuper": 0,
  • "ramsuper": 0,
  • "hddsuper": 0,
  • "cpubamf": 0,
  • "rambambf": 0,
  • "hddbamf": 0,
  • "repotag": "string",
  • "enviromentParameters": [ ],
  • "commands": [ ],
  • "domains": [ ],
  • "compose": [ ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Verify app update specifications

Verify and format application update specifications. Public

Request Body schema: application/json
required
appname
required
string

Application name

version
required
integer

New application version

description
string

Updated application description

port
integer

Application port

containerPort
integer

Container port

cpu
number

CPU requirements

ram
integer

RAM requirements in MB

hdd
integer

Storage requirements in GB

repotag
string

Docker repository tag

enviromentParameters
Array of arrays

Environment variables

commands
Array of arrays

Container commands

domains
Array of arrays

Custom domains

compose
Array of arrays

Docker compose configuration

Responses

Request samples

Content type
application/json
{
  • "appname": "string",
  • "version": 0,
  • "description": "string",
  • "port": 0,
  • "containerPort": 0,
  • "cpu": 0,
  • "ram": 0,
  • "hdd": 0,
  • "repotag": "string",
  • "enviromentParameters": [ ],
  • "commands": [ ],
  • "domains": [ ],
  • "compose": [ ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get application specifications USD price

Get the USD price for application specifications and resource usage. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Poll application logs

Poll application logs with real-time updates. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application

query Parameters
lines
integer
Default: 100

Number of log lines to return

since
string

Return logs since timestamp

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Stream application monitoring data

Get real-time streaming monitoring data for an application. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application

Responses

Test application installation

Test if an application can be installed without actually installing it. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application to test

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Install application locally

Install a specific application locally on this node. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application to install

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Redeploy application

Redeploy an existing application. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string

Name of the application to redeploy

query Parameters
force
boolean
Default: false

Force redeployment even if running

global
boolean
Default: false

Redeploy globally across network

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Reconstruct application message hashes

Reconstruct the application message hash collection. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Start application monitoring

Start monitoring for a specific application. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application to monitor

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Stop application monitoring

Stop monitoring for a specific application. AppOwnerAbove

Authorizations:
ZelID
path Parameters
appname
required
string
Example: electrumxtest

Name of the application

query Parameters
deletedata
boolean
Default: false

Whether to delete monitoring data

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get public key for app operations

Get the public key used for application operations. User

Authorizations:
ZelID
Request Body schema: application/json
required
message
string

Message to sign

signature
string

Signature of the message

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "signature": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Explorer

Calls that interact with locally running explorer

View FluxNode transactions

View a filtered list of the FluxNode's transactions. Public

query Parameters
filter
required
string
Example: filter=47.22.47.180

Filter using Ip, Flux address, or Collateral hash

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

View utxo history

View unspent transaction outputs of selected address. Public

query Parameters
address
required
string
Example: address=t1edbnsYnGXxyYNt4kJJPhZktDWNaKwkznY

Flux address to look up utxo's

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

View transaction history

View transaction history of selected address. Public

query Parameters
address
required
string
Example: address=t1edbnsYnGXxyYNt4kJJPhZktDWNaKwkznY

Flux address to look up tx history

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

View balance

View balance of selected address. Public

query Parameters
address
required
string
Example: address=t1edbnsYnGXxyYNt4kJJPhZktDWNaKwkznY

Flux address to look up balance

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 7089180145154
}

View scanned block height

View scanned block height on the explorer that it has synced. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Check if explorer is synced

Check if the explorer is fully synchronized with the blockchain. User

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Reindex collection

Drop Flux collection and recreate it. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Explorer database reindex initiated"
}

Restart block processing

Restarts Flux collection. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Block processing initiated"
}

Stops block processing

Stops Flux collection. AdminAndFluxTeam

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Block processing is stopped"
}

Rescan explorer

Rescan explorer from selected block height. AdminAndFluxTeam

Authorizations:
ZelID
query Parameters
blockheight
required
integer
Example: blockheight=585000

Block height to start rescan from

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "Explorer rescan from blockheight 585000 initiated"
}

Syncthing

Calls that interact with Syncthing service

Set an error message

Post with an error message in the body (plain text) to register a new error. The new error will be displayed on any active GUI clients. AdminAndFluxTeam

Authorizations:
ZelID
Request Body schema: text/plain
required
string

Responses

Request samples

Content type
text/plain
Test error

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

List of error messages

Get list with error message. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Remove all recent errors

Post with empty body to remove all recent errors. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Syncthing version information

Returns the current Syncthing version information. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Perform an upgrade

Perform an upgrade to the newest released version and restart. Does nothing if there is no newer version than currently running. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Checks for a possible upgrade

Checks for a possible upgrade and returns an object describing the newest version and upgrade possibility. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns a list of directories

Returns a list of directories matching the path given by the optional parameter current. The path can use patterns as described in Go’s filepath package. A ‘*’ will always be appended to the given path (e.g. /tmp/ matches all its subdirectories). If the option current is not given, filesystem root paths are returned. Admin

Authorizations:
ZelID
query Parameters
current
string
Example: current=/var/

Path name.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Pause the given device or all devices

Pause the given device or all devices. Takes the optional parameter device (device ID). When omitted, pauses all devices. Returns status 200 and no content upon success, or status 500 and a plain text error on failure. Admin

Authorizations:
ZelID
query Parameters
device
string
Example: device=7IKKJI5E346YQTBCVFJMH6O5VBNHZXRLVCG7HE6I5ZV6B8SLMTNJAFAO

Device ID (optional).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Resume the given device or all devices

Resume the given device or all devices. Takes the optional parameter device (device ID). When omitted, pauses all devices. Returns status 200 and no content upon success, or status 500 and a plain text error on failure. Admin

Authorizations:
ZelID
query Parameters
device
string
Example: device=7IKKJI5-E346YQT-BCVFJMH-6O5VBNH-ZXRLVCG-7HE6I5Z-V6B8SLM-TNJAFAO

Device ID (optional).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Restart Syncthing

Immediately restart Syncthing. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Shutdown Syncthing

Immediately shutdown Syncthing. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Erase the current index database and restart Syncthing

Erase the current index database and restart Syncthing. With no query parameters, the entire database is erased from disk. By specifying the folder parameter with a valid folder ID, only information for that folder will be erased. Admin

Authorizations:
ZelID
query Parameters
folder
string
Example: folder=ab1c2-def3g

Folder ID (optional)

Caution See --reset-database for .stfolder creation side-effect and caution regarding mountpoints.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Status of Syncthing

Returns information about current system status and resource usage. The CPU percent value has been deprecated from the API and will always report 0. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the path locations

Returns the path locations used internally for storing configuration, database, and others. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the list of configured devices and some metadata associated with them

Returns the list of configured devices and some metadata associated with them. The list also contains the local device itself as not connected. The connection types are TCP (Client), TCP (Server), Relay (Client) and Relay (Server). Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns/Add local discovery cache

Returns the contents of the local discovery cache. Admin

Authorizations:
ZelID
query Parameters
device
string
Example: device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q

DeviceID

addr
string
Example: addr=192.162.129.11:22000

Addres with port

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the set of debug facilities.

Returns the set of debug facilities and which of them are currently enabled. Enables or disables debugging for specified facilities. Give one or both of enable and disable query parameters, with comma separated facility names. To disable debugging of the beacon and discovery packages, and enable it for config and db. Admin

Authorizations:
ZelID
query Parameters
disable
string
Example: disable=beacon,discovery

List of facilities to disable (optional).

enable
string
Example: enable=config,db

List of facilities to enable (optional).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the list of recent log entries

Returns the list of recent log entries. The optional since parameter limits the results to message newer than the given timestamp in RFC 3339 format. Admin

Authorizations:
ZelID
query Parameters
since
string
Example: since=2023-07-07T13:31:17.470078189Z

Timestamp in RFC 3339 format (optional).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the list of recent log entries as text

Returns the list of recent log entries as text. The optional since parameter limits the results to message newer than the given timestamp in RFC 3339 format. Admin

Authorizations:
ZelID
query Parameters
since
string
Example: since=2023-07-07T13:31:17.470078189Z

Timestamp in RFC 3339 format (optional).

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "2023-07-07T13:32:18Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:33:19Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:34:26Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:35:26Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:36:28Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:37:28Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:38:30Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:39:30Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:40:31Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:41:31Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:42:32Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:43:32Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:44:34Z: Listen (BEP/tcp): TLS handshake: EOF\n2023-07-07T13:45:35Z: Listen (BEP/tcp): TLS handshake: EOF\n"
}

Ping pong tester call

Return {"ping": "pong"} object. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns config

Returns the entire config. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "compression": "metadata",
  • "certName": "",
  • "introducer": false,
  • "skipIntroductionRemovals": false,
  • "introducedBy": "",
  • "paused": true,
  • "allowedNetworks": [ ],
  • "autoAcceptFolders": false,
  • "maxSendKbps": 0,
  • "maxRecvKbps": 0,
  • "ignoredFolders": [ ],
  • "maxRequestKiB": 0,
  • "untrusted": false,
  • "remoteGUIPort": 0,
  • "gui": {
    },
  • "ldap": {
    },
  • "options": {
    },
  • "remoteIgnoredDevices": [ ],
  • "defaults": {
    }
}

Returns device config section

Returns all devices as an array. Returns the device for the given ID. Public

query Parameters
id
string
Example: id=PVI7HIK-QOY4UCX-5UGMOMA-A5E2ZXN-D2IOC5R-7ADG2X7-6G33ELX-APLV4QQ

DeviceID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns folder config section

Returns all folders as an array. Returns the folders for the given ID. Public

query Parameters
id
string
Example: id=ab1c2-def3g

FolderID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Replace folder config section

Replace folder config section. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Returns a template folder configuration

Returns a template folder configuration object with all default values, which only needs a unique ID to be applied. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns a template device configuration

Returns a template device configuration object with all default values, which only needs a unique ID to be applied. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns an object with a single lines attribute

Returns an object with a single lines attribute listing ignore patterns to be used by default on folders, as an array of single-line strings. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the respective object

GET returns the respective object, PUT replaces the entire object and PATCH replaces only the given child objects. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the respective object of gui config

GET returns the respective object, PUT replaces the entire object and PATCH replaces only the given child objects. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Replaces the entire gui object in config

Replaces the entire gui object in config. Admin

Authorizations:
ZelID
Request Body schema: text/plain
required
object

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Returns the respective object

GET returns the respective object, PUT replaces the entire object and PATCH replaces only the given child objects. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Replaces the entire ldap config object

Replaces the entire ldap config object. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Status of restart required

GET returns whether a restart of Syncthing is required for the current config to take effect. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns general statistics about devices

Returns general statistics about devices. Currently, only contains the time the device was last seen and the last connection duration. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns general statistics about folder

Returns general statistics about folders. Currently contains the last scan time and the last synced file. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Lists remote devices which have tried to connect

Lists remote devices which have tried to connect, but are not yet configured in our instance. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Remove records about a pending remote device which tried to connect

Remove records about a pending remote device which tried to connect. Valid values for the device parameter are those from the corresponding GET /rest/cluster/pending/devices endpoint. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
device
string

Responses

Request samples

Content type
application/json
{
  • "device": "XHZAEFI-RFF7ATI-6LXKNWK-FCSD7FF-3URL6RN-OJQMS5T-EIDFDZX-R6QGYAZ"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Lists folders which remote devices have offered to us, but are not yet shared from our instance to them

Lists folders which remote devices have offered to us, but are not yet shared from our instance to them. Takes the optional device parameter to only return folders offered by a specific remote device. Other offering devices are also omitted from the result. Public

query Parameters
id
string
Example: id=XHZAEFI-RFF7ATI-6LXKNWK-FCSD7FF-3URL6RN-OJQMS5T-EIDFDZX-R6QGYAZ

Device ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Remove records about a pending folder announced from a remote device

Remove records about a pending folder announced from a remote device. Valid values for the folde parameters are those from the corresponding GET /rest/cluster/pending/folders endpoint. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
folder
string

Responses

Request samples

Content type
application/json
{
  • "folder": "new-folder2"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Returns the list of errors encountered during scanning or pulling

Takes one mandatory parameter, folder, and returns the list of errors encountered during scanning or pulling. Public

query Parameters
folder
required
string
Example: folder=new-folder2

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the list of archived files that could be recovered

Takes one mandatory parameter, folder, and returns the list of archived files that could be recovered. How many versions are available depends on the File Versioning configuration. Each entry specifies when the file version was archived as the versionTime, the modTime when it was last modified before being archived, and the size in bytes. Public

query Parameters
folder
required
string
Example: folder=new-folder2

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the directory tree of the global model

Returns the directory tree of the global model. takes one mandatory folder parameter and two optional parameters levels and prefix. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

levels
number
Example: levels=2

Error level

prefix
string
Example: prefix=DCIM

Prefix

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Returns the completion percentage and byte / item counts

Returns the completion percentage (0 to 100) and byte / item counts. Takes optional device and folder parameters. Public

query Parameters
folder
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

device
string
Example: device=7IKKJI5-E34NYQT-BCVFJMH-6O5YBNH-ZXRLVCG-7HE6I5Z-V6B5SLM-TNJAFAO

Device ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the content of the .stignore as the ignore field

Takes one parameter, folder, and returns the content of the .stignore as the ignore field. A second field, expanded, provides a list of strings which represent globbing patterns described by gobwas/glob (based on standard wildcards) that match the patterns in .stignore and all the includes. If appropriate these globs are prepended by the following modifiers ! to negate the glob, (?i) to do case insensitive matching and (?d) to enable removing of ignored files in an otherwise empty directory. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updates the content of the .stignore

Expects a format similar to the output of GET /rest/db/ignores call, but only containing the ignore field (expanded field should be omitted). It takes one parameter, folder, and either updates the content of the .stignore echoing it back as a response, or returns an error. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Returns the list of files which were changed locally in a receive-only folder

Takes one mandatory parameter, folder, and returns the list of files which were changed locally in a receive-only folder. Thus they differ from the global state and could be reverted by pulling from remote devices again. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns lists of files which are needed by this device in order for it to become in sync

Takes one mandatory parameter, folder, and returns lists of files which are needed by this device in order for it to become in sync. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns the list of files which are needed by that remote device in order for it to become in sync with the shared folder

Takes the mandatory parameters folder and device, and returns the list of files which are needed by that remote device in order for it to become in sync with the shared folder. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

device
required
string
Example: device=QOYZMHI-VRZGOOI-VA76CAS-YGYK7Q2-H74L64R-JDCAFNQ-JRKYDCZ-UFM7IAE

Device ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns information about the current status of a folder

Returns information about the current status of a folder. Parameters folder, the ID of a folder. Public

query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

Folder ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Request immediate scan

Request immediate scan. Takes the optional parameters folder (folder ID). Admin

Authorizations:
ZelID
Request Body schema: application/json
folder
string

folder

Responses

Request samples

Content type
application/json
{
  • "folder": "fluxwp_wordpress1678382606717"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Request revert of a receive only folder

Request revert of a receive only folder. Reverting a folder means to undo all local changes. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
folder
string

folder

Responses

Request samples

Content type
application/json
{
  • "folder": "fluxwp_wordpress1678382606717"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Moves the file to the top of the download queue

Moves the file to the top of the download queue folder and file params are mandatory. Admin

Authorizations:
ZelID
Request Body schema: application/json
required
folder
string

folder

file
string

folder

Responses

Request samples

Content type
application/json
{
  • "folder": "fluxwp_wordpress1678382606717",
  • "file": "/"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Request override of a send only folder

Request override of a send only folder. Override means to make the local version latest, overriding changes made on other devices. This API call does nothing if the folder is not a send only folder. Takes the mandatory parameter folder (folder ID). Admin

Authorizations:
ZelID
Request Body schema: application/json
required
folder
string

folder

Responses

Request samples

Content type
application/json
{
  • "folder": "fluxwp_wordpress1678382606717"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": ""
}

Returns events

To filter the event list, in effect creating a specific subscription for only the desired event types, add a parameter events=EventTypeA,EventTypeB,... where the event types are any of the Event Types. If no filter is specified, all events except LocalChangeDetected and RemoteChangeDetected are included. The optional parameter since=lastSeenID sets the ID of the last event you've already seen. Syncthing returns a JSON encoded array of event objects, starting at the event just after the one with this last seen ID. The default value is 0, which returns all events. There is a limit to the number of events buffered, so if the rate of events is high or the time between polling calls is long some events might be missed. This can be detected by noting a discontinuity in the event IDs. If no new events are produced since lastSeenID, the HTTP call blocks and waits for new events to happen before returning. By default it times out after 60 seconds returning an empty array. The time out duration can be customized with the optional parameter timeout=seconds. To receive only a limited number of events, add the limit=n parameter with a suitable value for n and only the last n events will be returned. This can be used to catch up with the latest event ID after a disconnection. Public

query Parameters
events
required
string
Example: events=ConfigSaved

Event Type

since
string
Example: since=2023-07-25T15:09:45.220376293Z

Show events since specyfic time

limit
number
Example: limit=2

Parameter with a suitable value for n and only the last n events will be returned

timeout
number
Example: timeout=65

The time out duration

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Returns events

To filter the event list, in effect creating a specific subscription for only the desired event types, add a parameter events=EventTypeA,EventTypeB,... where the event types are any of the Event Types. If no filter is specified, all events except LocalChangeDetected and RemoteChangeDetected are included. The optional parameter since=lastSeenID sets the ID of the last event you've already seen. Syncthing returns a JSON encoded array of event objects, starting at the event just after the one with this last seen ID. The default value is 0, which returns all events. There is a limit to the number of events buffered, so if the rate of events is high or the time between polling calls is long some events might be missed. This can be detected by noting a discontinuity in the event IDs. If no new events are produced since lastSeenID, the HTTP call blocks and waits for new events to happen before returning. By default it times out after 60 seconds returning an empty array. The time out duration can be customized with the optional parameter timeout=seconds. To receive only a limited number of events, add the limit=n parameter with a suitable value for n and only the last n events will be returned. This can be used to catch up with the latest event ID after a disconnection. Public

query Parameters
events
required
string
Example: events=LocalChangeDetected

Event Type

since
string
Example: since=2023-07-25T15:09:45.220376293Z

Show events since specyfic time

limit
number
Example: limit=2

Parameter with a suitable value for n and only the last n events will be returned

timeout
number
Example: timeout=65

The time out duration

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Returns the data sent in the anonymous usage report

Returns the data sent in the anonymous usage report. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns a strong random generated string

Returns a strong random generated string (alphanumeric) of the specified length. Takes the length parameter. Public

query Parameters
length
number
Example: length=10

String length

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Verifies and formats a device ID.

Verifies and formats a device ID. Accepts all currently valid formats (52 or 56 characters with or without separators, upper or lower case, with trivial substitutions). Takes one parameter, id, and returns either a valid device ID in modern format, or an error. Public

query Parameters
id
string
Example: id=7IKKJI5-E34NYQT-BCVFJMH-6O5YBNH-ZXRLVCG-7HE6I5Z-V6B5SLM-TNJAFA0

DeviceID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Returns statistics about each served REST API endpoint

Returns statistics about each served REST API endpoint, to diagnose how much time was spent generating the responses. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Summarizes the completion percentage for each remote device

Summarizes the completion percentage for each remote device. Returns an object with device IDs as keys and an integer percentage as values. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Used to capture a profile of what Syncthing is doing on the CPU

The profiling starts when the page is requested and takes 30 seconds. During this time it will seem like nothing is happening and the browser is just waiting, hung, or “spinning”. Don’t worry - leave it be and have patience. Once done the profiling will result in a download called something like syncthing-cpu-windows-amd64-v0.14.4-112233.pprof. This is the file to keep and send in, without modifying the file name as it tells us information necessary to interpret it. Public

Responses

Used to capture a profile of what Syncthing is doing with the heap memory

The profiling will result in a download called something like syncthing-heap-windows-amd64-v0.14.4-112233.pprof. This is the file to keep and send in, without modifying the file name as it tells us information necessary to interpret it. Public

Responses

Collects information about the running instance for troubleshooting purposes

Returns a “support bundle” as a zipped archive, which should be sent to the developers after verifying it contains no sensitive personal information. Credentials for the web GUI and the API key are automatically redacted already. Public

Responses

Shows diagnostics about a certain file in a shared folder

Shows diagnostics about a certain file in a shared folder. Takes the folder (folder ID) and file (folder relative path) parameters. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=fluxwp_wordpress1678382606717

folder ID

file
required
string
Example: file=/

folder relative path

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Display deviceid

Returns deviceid. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2"
}

Display metadata information

Returns metadata variable. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": "var metadata = {\"deviceID\":\"7IKKJI5-E34NYQT-BCVFJMH-6O5WBNH-ZXRLVCG-7HE6I5Z-V6B8SLM-TNJAFAO\"};"
}

Check health status

Returns health status object. Public

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Fluxshare

Calls that interact with Fluxshare service

Share files

Call to retrieve share file. Admin

Authorizations:
ZelID
query Parameters
file
required
string
Example: file=5688d73c4e136d1e0ef33b600

File name of share file to view or download. Can be nested in additional folder.

token
required
string
Example: token=d52e40a6559facb74ecc97d9284b8eba75bcb16c4349ccedc4dfb29f9c41d2c0

token

Responses

Response samples

Content type
application/file
Hello world

FluxShare - Get folder content

Call to get content of folder in fluxshare. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=test

The name of the folder that content will be display

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Create folder

Call to create folder in fluxshare. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=test

The name of the folder that will be created in fluxshare

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Remove file

Call to remove file from fluxshare. Admin

Authorizations:
ZelID
query Parameters
file
required
string
Example: file=test

The name of the file that will be removed in fluxshare

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Remove folder

Call to remove folder from fluxshare. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=test

The name of the folder that will be removed in fluxshare

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - File exists

Call to check if file exist. Admin

Authorizations:
ZelID
query Parameters
file
required
string
Example: file=message.txt

File name to check if exists

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Stats

Call to check stats of fluxshare. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Share file

Call to share file in fluxshare. Admin

Authorizations:
ZelID
query Parameters
file
required
string
Example: file=message.txt

File name that will be share

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Unshare file

Call to unshare file in fluxshare. Admin

Authorizations:
ZelID
query Parameters
file
required
string
Example: file=message.txt

File name that will be unshare

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Shared files

Call to display shared files. Admin

Authorizations:
ZelID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Rename file

Call to rename file in fluxshare. Admin

Authorizations:
ZelID
query Parameters
oldpath
required
string
Example: oldpath=test%2Fb1fcb9da0a941468f2c8cde01.txt

Path to file

newname
required
string
Example: newname=2Fb1fcb9da0a941468f2c8cde02.txt

New name for file

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FluxShare - Download folder

Call to download content of folder in fluxshare. Admin

Authorizations:
ZelID
query Parameters
folder
required
string
Example: folder=test

The name of the folder

Responses

Response samples

Content type
application/file
Hello world

Fluxshare - Upload file

Uploads a file. Admin

Authorizations:
ZelID
query Parameters
folder
string
Example: folder=ddd/ccc

path inside fluxshare

Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Backup/Restore

Calls that interact with appication Backup/Restore service

Get volume data of a component

Get volume data of a component. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11

Name of the application

component
required
string
Example: component=FoldingAtHome

Component of application

multiplier
string
Example: multiplier=B

Multiplier value (B, KB, MB, GB, TB)

decimal
number
Example: decimal=2

Decimal value

fields
required
string
Example: fields=size,used

Fields to include, possibls mount, size, used, available, capacity, filesystem separate with coma

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Get size of a remote file. **AppOwnerAbove**

Get size of a remote file. AppOwnerAbove

Authorizations:
ZelID
query Parameters
fileurl
required
string
Example: fileurl=https://go.dev/dl/go1.22.1.darwin-amd64.tar.gz

Remote URL

multiplier
string
Example: multiplier=B

Multiplier value (B, KB, MB, GB, TB)

decimal
number
Example: decimal=2

Decimal value

number
boolean
Example: number=true

return only number

appname
string
Example: appname=FoldingAtRunOnFlux11

Application name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": 67267354
}

Get the list of local backups based on the provided appname

Get the list of local backups based on the provided appname. AppOwnerAbove

Authorizations:
ZelID
query Parameters
fileurl
required
string
Example: fileurl=%2Fhome%2Fflux01%2Fzelflux%2FZelApps%2FfluxFoldingAtHome_FoldingAtRunOnFlux11%2Fbackup%2Flocal

Full path

multiplier
string
Example: multiplier=B

Multiplier value (B, KB, MB, GB, TB)

decimal
number
Example: decimal=2

Decimal value

number
boolean
Example: number=true

return only number

appname
string
Example: appname=FoldingAtRunOnFlux11

Application name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Remove a backup file.

Remove a backup file.AppOwnerAbove

Authorizations:
ZelID
query Parameters
filepath
required
string
Example: filepath=%2Fhome%2Fflux05%2Fzelflux%2FZelApps%2FfluxFoldingAtHome_FoldingAtRunOnFlux11%2Fbackup%2Flocal%2Fbackup_foldingathome.tar.gz

Full path

appname
required
string
Example: appname=FoldingAtRunOnFlux11

Application name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Download a local backup file

Download a local backup file. AppOwnerAbove

Authorizations:
ZelID
query Parameters
filepath
required
string
Example: filepath=%2Fhome%2Fflux05%2Fzelflux%2FZelApps%2FfluxFoldingAtHome_FoldingAtRunOnFlux11%2Fbackup%2Flocal%2Fbackup_foldingathome.tar.gz

Full path

appname
required
string
Example: appname=FoldingAtRunOnFlux11

Application name

Responses

Append backup task to an application

Append backup task to an application. AppOwnerAbove

Authorizations:
ZelID
Request Body schema: application/json
required
appname
string

Name of the application

Array of objects

Responses

Request samples

Content type
application/json
{
  • "appname": "FoldingAtRunOnFlux11",
  • "backup": [
    ]
}

Append restore task to an application

Append restore task to an application. AppOwnerAbove

Authorizations:
ZelID
Request Body schema: application/json
required
appname
string

Name of the application

Array of objects

Responses

Request samples

Content type
application/json
{
  • "appname": "FoldingAtRunOnFlux11",
  • "restore": [
    ]
}

Volume Browser

Calls that interact with application Volume Browser service

Get a list of files with their details for all files.

Get a list of files with their details for all files. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
folder
string
Example: folder=ddd

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create folder.

Create folder inside app volume. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
folder
required
string
Example: folder=ddd

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Rename file/folder

Rename file/folder. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
oldpath
required
string
Example: oldpath=ddd

old path name inside volume with file/folder name

newname
required
string
Example: newname=ccc

new full path name inside volume with file/folder name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Remove file/folder

Remove file/folder. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
object
required
string
Example: object=ddd

path name inside volume with file/folder name

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

Download file

Download file. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
file
required
string
Example: file=notes.txt

full path inside volume to file

Responses

Download folder as gzip file

Download folder as gzip file. AppOwnerAbove

Authorizations:
ZelID
query Parameters
appname
required
string
Example: appname=FoldingAtRunOnFlux11
component
required
string
Example: component=FoldingAtHome
folder
required
string
Example: folder=ddd

full path inside volume to folder

Responses

IOUtils

Calls that interact with files operations

Upload file

Uploads a file to the specified location. AppOwnerAbove

Authorizations:
ZelID
query Parameters
type
required
string
Example: type=volume

Type of upload (backup or volume)

appname
required
string
Example: appname=FoldingAtRunOnFlux11

Name of the application

component
required
string
Example: component=FoldingAtHome

Component of application

folder
string
Example: folder=ddd/ccc

Full path inside volume to the folder

filename
string
Example: filename=FoldingAtHome.gzip

Name of the file to be uploaded. If not provided, the file will be uploaded with its original name.

Request Body schema: multipart/form-data
required
file
string <binary>

Responses